|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.nasa.pds.label.Label
public class Label
Implements a mechanism for accessing labels and the objects they represent.
For PDS4 labels, the user should load a label file and access the objects as follows:
Label label = Label.open(new File("labelfile.xml"); // Get the tables in the data file. List<TableObject> tables = label.getObjects(TableObject.class); // Read the table record-by-record. TableObject table = tables.get(0); TableRecord record = table.readNext(); while (record != null) { ... process this record ... } label.close();
See the package gov.nasa.pds.object
to see all the
object types that can be represented in a PDS label.
Method Summary | ||
---|---|---|
void |
close()
Closes the label. |
|
LabelStandard |
getLabelStandard()
Gets the label standard that the label conforms to. |
|
List<DataObject> |
getObjects()
Gets the data objects represented by the label. |
|
|
getObjects(Class<T> clazz)
Gets the data objects that are of a given class. |
|
Class<? extends Product> |
getProductClass()
Gets the object class of the product. |
|
ProductType |
getProductType()
Gets the type of the product, as an enumerated type. |
|
String |
getStandardVersion()
Returns the version number of the label standard used by the product. |
|
static Label |
open(File labelFile)
Opens a label from a file. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void close()
public static Label open(File labelFile) throws ParseException
labelFile
- the label file
ParseException
- if there is an error reading the label from the filepublic LabelStandard getLabelStandard()
public String getStandardVersion()
public Class<? extends Product> getProductClass()
public ProductType getProductType()
public List<DataObject> getObjects() throws Exception
Exception
- if there is an error accessing the objects in the productpublic <T extends DataObject> List<T> getObjects(Class<T> clazz) throws Exception
T
- the class of the objects desiredclazz
- the class object of the object class
Exception
- if there is an error accessing the objects in the product
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |