HiRISE

HiRISE.HiCat.HiTList
Class ROIFBuilder

java.lang.Object
  extended by HiRISE.HiCat.HiTList.ROIFBuilder

public class ROIFBuilder
extends Object

Build ROI records from a data vector retrieved from HiCat. The class will accept several different types of input lists, (eg. "First Half Stereo", "Second Half Stereo", "High Stability", etc). The "COMMENT" field of the generated ROI records will contain additional information depending on the type of list being added to this object.

Version:
1.2
Author:
Rodney heyd UA/PIRL

Field Summary
static String DEBUG_ADD_VECTOR_PROPERTY
           
static String DEBUG_CONSTRUCTOR_PROPERTY
           
static String DEBUG_DUPLICATE_PROPERTY
           
static String DEBUG_RECORD_PROPERTY
           
static String DEBUG_WRITE_PROPERTY
           
static String ID
          Class identification name with source code version and date.
 
Constructor Summary
ROIFBuilder()
          Create an ROIF_Builder object.
 
Method Summary
 void add(Vector<Vector<String>> data_vector, Vector<String> column_names, TargetList.ListTypes list_type)
          Add a list of records to the object for output in a region of interest file.
 void Write()
          Writes the ROI records contained in this object to System.out
 void Write(OutputStream output)
          Writes the ROI records contained in this object to the specified OutputStream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ID

public static final String ID
Class identification name with source code version and date.

See Also:
Constant Field Values

DEBUG_CONSTRUCTOR_PROPERTY

public static final String DEBUG_CONSTRUCTOR_PROPERTY
See Also:
Constant Field Values

DEBUG_ADD_VECTOR_PROPERTY

public static final String DEBUG_ADD_VECTOR_PROPERTY
See Also:
Constant Field Values

DEBUG_RECORD_PROPERTY

public static final String DEBUG_RECORD_PROPERTY
See Also:
Constant Field Values

DEBUG_WRITE_PROPERTY

public static final String DEBUG_WRITE_PROPERTY
See Also:
Constant Field Values

DEBUG_DUPLICATE_PROPERTY

public static final String DEBUG_DUPLICATE_PROPERTY
See Also:
Constant Field Values
Constructor Detail

ROIFBuilder

public ROIFBuilder()
Create an ROIF_Builder object. The ROIF file will be output according to the precedence values defined for each list in the TargetList.ListTypes enumeration.

Method Detail

add

public void add(Vector<Vector<String>> data_vector,
                Vector<String> column_names,
                TargetList.ListTypes list_type)
         throws ROIF_Exception
Add a list of records to the object for output in a region of interest file.

Parameters:
data_vector - - a vector in which each element is another vector representing each record to be output.
column_names - - a vector containing the column names of the data_vector.
list_type - - A string containing the name of the type of list being added. This list_type should correspond to one of the list_types in the Precedence hashtable.
Throws:
ROIF_Exception

Write

public void Write(OutputStream output)
Writes the ROI records contained in this object to the specified OutputStream

Parameters:
output - The OutputStream the ROI's should be written to. This should normally be a FileOutputStream.

Write

public void Write()
Writes the ROI records contained in this object to System.out

See Also:
Write(OutputStream)

HiRISE

Copyright (C) Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona