Class InventoryTableReader

java.lang.Object
gov.nasa.pds.tools.inventory.reader.InventoryTableReader
All Implemented Interfaces:
InventoryReader

public class InventoryTableReader
extends Object
implements InventoryReader
Class that supports reading of a table-version of the PDS Inventory file.
Author:
mcayanan
  • Field Details

    • FIELD_DELIMITER

      public static final String FIELD_DELIMITER
      XPath to determine the field delimiter being used in the inventory table.
      See Also:
      Constant Field Values
    • MEMBER_STATUS_FIELD_NUMBER

      public static final String MEMBER_STATUS_FIELD_NUMBER
      XPath to determine the field location of the member status field in the inventory table.
      See Also:
      Constant Field Values
    • LIDVID_LID_FIELD_NUMBER

      public static final String LIDVID_LID_FIELD_NUMBER
      XPath to determine the field location of the LID-LIDVID field in the inventory table.
      See Also:
      Constant Field Values
    • DATA_FILE

      public static final String DATA_FILE
      XPath to the external table file of a collection.
      See Also:
      Constant Field Values
  • Constructor Details

  • Method Details

    • getDataFile

      public URL getDataFile()
      Gets the data file that is being read.
      Returns:
      the data file.
    • getLineNumber

      public int getLineNumber()
      Gets the line number that was just read.
      Returns:
      the line number.
    • getNumRecords

      public int getNumRecords()
      Returns the records number in the PDS Inventory file.
    • getNext

      public InventoryEntry getNext() throws InventoryReaderException
      Gets the next product file reference in the PDS Inventory file.
      Specified by:
      getNext in interface InventoryReader
      Returns:
      A class representation of the next product file reference in the PDS inventory file. If the end-of-file has been reached, a null value will be returned.
      Throws:
      InventoryReaderException - If an error occurred while reading the Inventory file.