com.luciad.format.vpf

Defense StandardsClass TLcdVPFDatabaseGroup

java.lang.Object

com.luciad.format.vpf.TLcdVPFDatabaseGroup

public class TLcdVPFDatabaseGroup
extends java.lang.Object

Models a VPF directory containing multiple VPF databases. It offers functionality for retrieving all VPF databases within that directory. The database search is based on the presence of DHT files.

Constructor Summary

Constructors

Constructor and Description
TLcdVPFDatabaseGroup(java.lang.String aPathName) Creates a new TLcdVPFDatabaseGroup with the given path.

Method Summary

Modifier and Type	Method and Description
protected TLcdVPFDatabase	createDatabase(java.lang.String aPath) Instantiates a new TLcdVPFDatabase, initialized with the given path.
TLcdVPFDatabase[]	getDatabases() Returns an array containing all databases included in this database group, or an array of length zero if none exist.
java.lang.String	getDescription() Return a description of this database group.
java.lang.String	getName() Returns the name of this database group, which corresponds to the last part of the path name.
java.lang.String	getPathName() Returns the full path name of this database group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TLcdVPFDatabaseGroup

public TLcdVPFDatabaseGroup(java.lang.String aPathName)
                     throws java.io.FileNotFoundException,
                            TLcdCodecException

Creates a new TLcdVPFDatabaseGroup with the given path.

Parameters:

aPathName - the path of the root directory of this database group.

Throws:

java.io.FileNotFoundException - if the given path does not point to an existing directory.

TLcdCodecException - if one of the databases included in this database group has a corrupted DHT file.

Method Detail

getPathName

public java.lang.String getPathName()

Returns the full path name of this database group.

Returns:

the full path name of this database group.

getName

public java.lang.String getName()

Returns the name of this database group, which corresponds to the last part of the path name.

Returns:

a general description of this database group.

getDatabases

public TLcdVPFDatabase[] getDatabases()

Returns an array containing all databases included in this database group, or an array of length zero if none exist.

Returns:

an array containing all databases included in this database group, or an array of length zero if none exist.

getDescription

public java.lang.String getDescription()

Return a description of this database group. The path name is used as description.

Returns:

a description of this database group.

createDatabase

protected TLcdVPFDatabase createDatabase(java.lang.String aPath)
                                  throws TLcdCodecException,
                                         java.io.FileNotFoundException

Instantiates a new TLcdVPFDatabase, initialized with the given path.

Parameters:

aPath - the path containing the VPF data for which a database should be instantiated.

Returns:

a VPF database, initialized with the given path.

Throws:

TLcdCodecException - if a problem occurs during the decoding of the DHT file.

java.io.FileNotFoundException - if aSourceName does not point to a DHT file or a directory containing a DHT file.