public class TLcdVPFCoverage extends Object
A VPF coverage is part of a library (TLcdVPFLibrary
) and contains a set of feature classes
(TLcdVPFFeatureClass)
of the same theme (for example transportation).
There are five types of feature classes in a coverage: points, lines, areas, texts and complex features.
A coverage can contain zero or more feature classes of each type.
All geometries within the same coverage have the same topology level (see MIL-STD-2407, page 37 for a detailed description). Detailed topological relationships between objects are currently not available.
Optionally, a data quality descriptor can be associated with each coverage.
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o)
Returns
true if this VPF coverage is equal to the given object. |
String[] |
getAreaFeatureClassesDescription()
Returns an array containing the descriptions of all area feature classes in this coverage.
|
String[] |
getAreaFeatureClassesName()
Returns an array containing the names of all area feature classes in this coverage.
|
String[] |
getComplexFeatureClassesDescription()
Returns an array containing the descriptions of all complex feature classes in this coverage.
|
String[] |
getComplexFeatureClassesName()
Returns an array containing the names of all complex feature classes in this coverage.
|
TLcdVPFDataQualityDescriptor |
getDataQualityDescriptor()
Returns a description of the data quality of this coverage,
or
null if no data quality information is available for this coverage. |
Hashtable |
getDefaultFeatureClassDescriptions()
Returns the default (feature class name, feature class description) mapping that is used for retrieving
feature class descriptions, if no description is available in the
FCA table. |
String |
getDescription()
Returns a brief textual description for this entity.
|
TLcdVPFFeatureClass |
getFeatureClass(String aFeatureClassName)
Returns the
TLcdVPFFeatureClass with the given name that is part of this coverage,
or null if no such feature class exists. |
TLcdVPFFeatureClass[] |
getFeatureClasses()
Returns an array with all feature classes contained in this coverage.
|
TLcdVPFLibrary |
getLibrary()
Returns the library to which this coverage belongs.
|
String[] |
getLineFeatureClassesDescription()
Returns an array containing the descriptions of all line feature classes in this coverage.
|
String[] |
getLineFeatureClassesName()
Returns an array containing the names of all line feature classes in this coverage.
|
String |
getName()
Returns the short name of this entity, used as identifier in the VPF database.
|
File |
getPath()
Returns the path, as a
File , to the directory of this coverage,
for example /data/vmaplv0/eusproto/trans for
the transportation coverage in the eusproto library of the vmaplv0 database. |
String |
getPathName()
Returns the path to the directory of this coverage, for example
/data/vmaplv0/eusproto/trans for
the transportation coverage in the eusproto library of the vmaplv0 database. |
String[] |
getPointFeatureClassesDescription()
Returns an array containing the descriptions of all point feature classes in this coverage.
|
String[] |
getPointFeatureClassesName()
Returns an array containing the names of all point feature classes in this coverage.
|
String[] |
getTextFeatureClassesDescription()
Returns an array containing the descriptions of all text feature classes in this coverage.
|
String[] |
getTextFeatureClassesName()
Returns an array containing the names of all text feature classes in this coverage.
|
short |
getTopologyLevel()
Returns the topology level of this coverage.
|
int |
hashCode() |
protected void |
initDefaultFeatureClassDescriptions()
Called when the default feature class description mapping is first needed.
|
boolean |
isTraceOn()
Deprecated.
This method has been deprecated. It is recommended to use the
standard Java logging framework directly.
|
static void |
setClassTraceOn(boolean aClassTraceOn)
Deprecated.
This method has been deprecated. It is recommended to use the
standard Java logging framework directly.
|
void |
setDefaultFeatureClassDescriptions(Hashtable aName2DescriptionMap)
Sets a mapping of (feature class name, feature class description) on this coverage, that is used
if no valid description could be retrieved from the
FCA table (because it doesn't exist
or it doesn't contain an entry for the given feature class name). |
void |
setTraceOn(boolean aTraceOn)
Deprecated.
This method has been deprecated. It is recommended to use the
standard Java logging framework directly.
|
String |
toString()
Returns a brief textual description for this coverage.
|
public File getPath()
File
, to the directory of this coverage,
for example /data/vmaplv0/eusproto/trans
for
the transportation coverage in the eusproto library of the vmaplv0 database.public String getPathName()
/data/vmaplv0/eusproto/trans
for
the transportation coverage in the eusproto library of the vmaplv0 database.public TLcdVPFLibrary getLibrary()
public TLcdVPFFeatureClass[] getFeatureClasses()
FCS
table.public TLcdVPFFeatureClass getFeatureClass(String aFeatureClassName)
TLcdVPFFeatureClass
with the given name that is part of this coverage,
or null
if no such feature class exists.aFeatureClassName
- the name of the feature class to be returned.TLcdVPFFeatureClass
with the given name, or null
if no
such feature class exists.NullPointerException
- if aFeatureClassName == null
public String[] getPointFeatureClassesName()
FCS
table.String
objects containing the names of all point feature classes in this coverage.public String[] getLineFeatureClassesName()
FCS
table.String
objects containing the names of all line feature classes in this coverage.public String[] getAreaFeatureClassesName()
FCS
table.String
objects containing the names of all area feature classes in this coverage.public String[] getTextFeatureClassesName()
FCS
table.String
objects containing the names of all text feature classes in this coverage.public String[] getComplexFeatureClassesName()
FCS
table.String
objects containing the names of all complex feature classes in this coverage.public String[] getPointFeatureClassesDescription()
FCS
table.String
objects containing the descriptions of all point feature classes in this coverage.public String[] getLineFeatureClassesDescription()
FCS
table.String
objects containing the descriptions of all line feature classes in this coverage.public String[] getAreaFeatureClassesDescription()
FCS
table.String
objects containing the descriptions of all area feature classes in this coverage.public String[] getTextFeatureClassesDescription()
FCS
table.String
objects containing the descriptions of all text feature classes in this coverage.public String[] getComplexFeatureClassesDescription()
FCS
table.String
objects containing the descriptions of all complex feature classes in this coverage.public short getTopologyLevel()
MIL-STD-2407, p. 37 contains a more detailed description of all topological levels.
TLcdVPFCoverage
.public TLcdVPFDataQualityDescriptor getDataQualityDescriptor()
null
if no data quality information is available for this coverage.TLcdVPFDataQualityDescriptor
describing the data quality of this coverage.public void setDefaultFeatureClassDescriptions(Hashtable aName2DescriptionMap)
FCA
table (because it doesn't exist
or it doesn't contain an entry for the given feature class name).
If this mapping is null
and no FCA
entry is available, the feature class
names will also be used as descriptions.aName2DescriptionMap
- a Hashtable
containing feature class names as keys and
their corresponding feature class descriptions as values.getDefaultFeatureClassDescriptions()
public Hashtable getDefaultFeatureClassDescriptions()
FCA
table.setDefaultFeatureClassDescriptions(java.util.Hashtable)
protected void initDefaultFeatureClassDescriptions()
Hashtable
, and use
the setDefaultFeatureClassDescriptions()
method to set it on
this coverage.
The feature class names should be used as keys in the Hashtable
, the
corresponding descriptions as values.
By default, the table is initialized with default (English) values for a small set
of feature classes that occur frequently in reference libraries.public String toString()
getName()
or getDescription()
might be used as a good source of a textual description for this coverage.public boolean equals(Object o)
true
if this VPF coverage is equal to the given object.
Two VPF coverages are considered equal if the libraries to which they belong
are equal, and their names are equal.public static void setClassTraceOn(boolean aClassTraceOn)
true
then all log messages are recorded, otherwise only
the informative, warning and error messages are recorded.aClassTraceOn
- if true then all log messages are recorded,
otherwise only the informative, warning and error messages are recorded.public void setTraceOn(boolean aTraceOn)
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.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.public boolean isTraceOn()
true
if tracing is enabled for this class.public String getName()
public String getDescription()