Package com.luciad.format.vpf

Class TLcdVPFLibrary

java.lang.Object
com.luciad.format.vpf.TLcdVPFLibrary
public class TLcdVPFLibrary extends Object
Models the VPF library level. A VPF library is part of a database (TLcdVPFDatabase) and contains a set of coverages (TLcdVPFCoverage), all having the same geographic extent (for example Europa & Asia). All geometry within a VPF library is expressed in the same geographic reference system, associated with this library. Optionally, a data quality descriptor can be associated with each coverage.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    TLcdVPFLibrary(String aPathName, String aLibraryName, ILcdBuffer aBuffer)
    Creates a TLcdVPFLibrary which path is aPath and which name is aLibraryName.
    TLcdVPFLibrary(String aPathName, String aLibraryName, ILcdBuffer aBuffer, boolean aFullDecode)
    Creates a TLcdVPFLibrary which path is aPath and which name is aLibraryName (see description above).

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    decodeCAT()
    Deprecated.
    the CAT table is decoded automatically on the first attempt to access it.
    void
    decodeGRT()
    Deprecated.
    the GRT table is decoded automatically on the first attempt to access it.
    void
    decodeLHT()
    Deprecated.
    the LHT table is decoded automatically on the first attempt to access it.
    void
    decodeTILEREF()
    Deprecated.
    the TILEREF table is decoded automatically on the first attempt to access it.
    boolean
    equals(Object o)
    Returns true if this VPF library is equal to the given object.
    ILcdBounds
    getBounds()
    Returns the minimum bounding rectangle (MBR) of this library.
    TLcdVPFCoverage
    getCoverage(String aCoverageName)
    Returns the TLcdVPFCoverage of this library which name is aCoverageName.
    String[]
    getCoverageNames()
    Returns the names of all coverages contained in this library.
    TLcdVPFCoverage[]
    getCoverages()
    Returns an array containing all coverages that are part of this library.
    TLcdVPFDatabase
    getDatabase()
    Returns the database to which this library belongs.
    TLcdVPFDataQualityDescriptor
    getDataQualityDescriptor()
    Returns a description of the data quality of this library, or null if no data quality information is available for this library.
    String
    getDescription()
    Returns a brief textual description for this entity.
    ILcdModelReference
    getModelReference()
    Returns the ILcdModelReference describing the geographic reference system in which all geometry in this library is expressed.
    String
    getName()
    Returns the short name of this entity, used as identifier in the VPF database.
    String
    getPathName()
    Returns the path to the directory of this library, for example /data/vmaplv0/eusproto for the eusproto library of the vmaplv0 database.
    String
    getProductType()
    Returns the VPF product type identifier of this library (for example 'VMAP Level 0').
    int
    getScale()
    Returns the denominator of the source scale of the library.
    TLcdVPFTile[]
    getTiles()
    Returns an array of TLcdVPFTile objects, representing the tiling scheme used in this library, or null if this library is not tiled.
    int
    hashCode()
     
    boolean
    isTiled()
    Returns true if this library uses a tiling scheme for storing its geometry, false otherwise.
    boolean
    isTraceOn()
    Deprecated.
    This method has been deprecated.
    static void
    setClassTraceOn(boolean aClassTraceOn)
    Deprecated.
    This method has been deprecated.
    void
    setTraceOn(boolean aTraceOn)
    Deprecated.
    This method has been deprecated.
    String
    toString()
    Returns a brief textual description for this library.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TLcdVPFLibrary

      public TLcdVPFLibrary(String aPathName, String aLibraryName, ILcdBuffer aBuffer) throws TLcdCodecException, FileNotFoundException
      Creates a TLcdVPFLibrary which path is aPath and which name is aLibraryName.
      Parameters:
      aPathName - The path to the directory of this library.
      aLibraryName - The name of this library.
      aBuffer - This argument is no longer used.
      Throws:
      TLcdCodecException - If an IO exception occurs during initialization.
      FileNotFoundException - If a required table could not be found.

    • TLcdVPFLibrary

      public TLcdVPFLibrary(String aPathName, String aLibraryName, ILcdBuffer aBuffer, boolean aFullDecode) throws TLcdCodecException, FileNotFoundException
      Creates a TLcdVPFLibrary which path is aPath and which name is aLibraryName (see description above).
      Parameters:
      aPathName - The path to the directory of this library.
      aLibraryName - The name of this library.
      aBuffer - This argument is no longer used.
      aFullDecode - This argument is no longer used.
      Throws:
      TLcdCodecException - If an IO exception occurs during initialization.
      FileNotFoundException - If a required table could not be found.

  • Method Details

    • getPathName

      public String getPathName()
      Returns the path to the directory of this library, for example /data/vmaplv0/eusproto for the eusproto library of the vmaplv0 database.
      Returns:
      the path to the directory of this library.

    • getDescription

      public String getDescription()
      Returns a brief textual description for this entity.
      Returns:
      a brief textual description for this entity.

    • getDatabase

      public TLcdVPFDatabase getDatabase()
      Returns the database to which this library belongs.
      Returns:
      the database to which this library belongs.

    • getCoverages

      public TLcdVPFCoverage[] getCoverages()
      Returns an array containing all coverages that are part of this library. If the library contains no coverages, an array of length zero will be returned. The order of the coverages in the CAT table is preserved.
      Returns:
      all coverages that are part of this library.

    • getCoverageNames

      public String[] getCoverageNames()
      Returns the names of all coverages contained in this library. The order of the coverages in the CAT table is preserved.
      Returns:
      the names of all coverages contained in this library.

    • getCoverage

      public TLcdVPFCoverage getCoverage(String aCoverageName)
      Returns the TLcdVPFCoverage of this library which name is aCoverageName. If no coverage exists with the given name, null is returned.
      Parameters:
      aCoverageName - the name of the coverage to be returned. This should correspond to the name that is in the COVERAGE_NAME column of the CAT table.
      Returns:
      the TLcdVPFCoverage of this library which name is aCoverageName.
      Throws:
      NullPointerException - if aLibraryName == null

    • getProductType

      public String getProductType()
      Returns the VPF product type identifier of this library (for example 'VMAP Level 0').
      Returns:
      the VPF product type identifier of this library.

    • getScale

      public int getScale()
      Returns the denominator of the source scale of the library.
      Returns:
      the denominator of the source scale of the library.

    • getBounds

      public ILcdBounds getBounds()
      Returns the minimum bounding rectangle (MBR) of this library. The MBR is retrieved from the database's LAT table. It is always expressed in geodetic coordinates.
      Returns:
      the MBR of this library.

    • getModelReference

      public ILcdModelReference getModelReference()
      Returns the ILcdModelReference describing the geographic reference system in which all geometry in this library is expressed.
      Returns:
      the ILcdModelReference used within this library.

    • getDataQualityDescriptor

      public TLcdVPFDataQualityDescriptor getDataQualityDescriptor()
      Returns a description of the data quality of this library, or null if no data quality information is available for this library.
      Returns:
      the TLcdVPFDataQualityDescriptor describing the data quality of this library.

    • getTiles

      public TLcdVPFTile[] getTiles()
      Returns an array of TLcdVPFTile objects, representing the tiling scheme used in this library, or null if this library is not tiled.
      Returns:
      an array of TLcdVPFTile objects, representing the tiling scheme used in this library.

    • isTiled

      public boolean isTiled()
      Returns true if this library uses a tiling scheme for storing its geometry, false otherwise.
      Returns:
      true if this library uses a tiling scheme, false otherwise.

    • decodeLHT

      public void decodeLHT() throws TLcdCodecException, FileNotFoundException
      Deprecated.
      the LHT table is decoded automatically on the first attempt to access it. This method should no longer be called explicitly.
      Decodes the LHT table of this library.
      Throws:
      TLcdCodecException - if an IO exception occurs during decoding of the LHT table.
      FileNotFoundException - if the LHT table does not exist.

    • decodeCAT

      public void decodeCAT() throws TLcdCodecException, FileNotFoundException
      Deprecated.
      the CAT table is decoded automatically on the first attempt to access it. This method should no longer be called explicitly.
      Decodes the CAT table of this library.
      Throws:
      TLcdCodecException - if an IO exception occurs during decoding of the CAT table.
      FileNotFoundException - if the CAT table does not exist.

    • decodeTILEREF

      public void decodeTILEREF()
      Deprecated.
      the TILEREF table is decoded automatically on the first attempt to access it. This method should no longer be called explicitly.
      Decodes the TILEREF table of this library.
      Throws:
      TLcdCodecException - if an IO exception occurs during decoding of the TILEREF table.
      FileNotFoundException - if the TILEREF table does not exist.

    • decodeGRT

      public void decodeGRT() throws TLcdCodecException, FileNotFoundException
      Deprecated.
      the GRT table is decoded automatically on the first attempt to access it. this method should no longer be called explicitly.
      Decodes the GRT table.
      Throws:
      TLcdCodecException - if an IO exception occurs during decoding of the GRT table.
      FileNotFoundException - if the GRT table does not exist.

    • toString

      public String toString()
      Returns a brief textual description for this library. The exact details of the representation are unspecified and subject to change. Depending on the application, the getName() or getDescription() might be used as a good source of a textual description for this library.
      Overrides:
      toString in class Object
      Returns:
      a brief textual description for this library.

    • equals

      public boolean equals(Object o)
      Returns true if this VPF library is equal to the given object. Two VPF libraries are considered equal if the databases to which they belong are equal, and their names are equal.
      Overrides:
      equals in class Object
      Parameters:
      o - the object to compare this library with.
      Returns:
      true if this object and o are equal, false otherwise.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • setClassTraceOn

      public static void setClassTraceOn(boolean aClassTraceOn)
      Deprecated.
      This method has been deprecated. It is recommended to use the standard Java logging framework directly.
      Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.
      Parameters:
      aClassTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.

    • setTraceOn

      public void setTraceOn(boolean aTraceOn)
      Deprecated.
      This method has been deprecated. It is recommended to use the standard Java logging framework directly.
      Enables tracing for this class instance. Calling this method with either true or false as argument automatically turns off tracing for all other class instances for which setTraceOn has not been called. If the argument is false then only the informative, warning and error log messages are recorded.
      Parameters:
      aTraceOn - if true then all log messages are recorded for this instance. If false, then only the informative, warning and error log messages are recorded.

    • isTraceOn

      public boolean isTraceOn()
      Deprecated.
      This method has been deprecated. It is recommended to use the standard Java logging framework directly.
      Returns true if tracing is enabled for this class.
      Returns:
      true if tracing is enabled for this class, false otherwise.

    • getName

      public String getName()
      Returns the short name of this entity, used as identifier in the VPF database. For example:
      • vmaplv0 for a database
      • eusproto for a library
      • trans for a coverage
      • roadl for a feature class
      Returns:
      the short name of this entity.