public class TLcdDAFIFTNavaidDecoder extends ALcdDAFIFTModelDecoder
ILcdModelDecoder
that decodes DAFIFT navaid objects (VOR, DME, NDB,
TACAN, VOR-DME, VORTAC and NDB-DME) from the specified source directory. The decoded models have
as model descriptor an instance of TLcdDAFIFNavaidModelListDescriptor
. This model list
descriptor contains instances of the descriptor TLcdDAFIFDMEModelDescriptor
,
TLcdDAFIFVORModelDescriptor
, TLcdDAFIFNDBModelDescriptor
and/or
TLcdDAFIFTACANModelDescriptor
, dependent of the source directory.
The objects in decoded models are based on the AIS domain objects available in com.luciad.ais.model
,
which all implement ILcdDataObject
. This interface provides a generic and
format-independent way of accessing the type and properties (features) of a domain object.
For this handler, the types of the decoded objects are TLcdDAFIFTDataTypes.VOR
,
TLcdDAFIFTDataTypes.DME
, TLcdDAFIFTDataTypes.TACAN
and
TLcdDAFIFTDataTypes.NDB
, which can also be retrieved through ILcdDataObject.getDataType()
.
The available properties of the objects are defined in TLcdDAFIFTVORDataProperties
,
TLcdDAFIFTDMEDataProperties
, TLcdDAFIFTTACANDataProperties
and
TLcdDAFIFTNDBDataProperties
.
The values for these properties can be retrieved through ILcdDataObject.getValue(com.luciad.datamodel.TLcdDataProperty)
.
Next to ILcdDataObject
, the objects in decoded models also implement ILcdFeatured
,
the former interface to access the properties (features) of a domain object.
This is still fully supported, and explained in the following comments.
The method setDMEFeaturesToBeDecoded
, setNDBFeaturesToBeDecoded
, setTACANFeaturesToBeDecoded
and setVORFeaturesToBeDecoded
allow
the user to specify which DAFIFT features are decoded into the featured model objects. If no features
are specified, all features will be decoded.
ILcdNavaidFeature.IDENTIFIER
ILcdDAFIFNavaidFeature.TYPE
ILcdDAFIFNavaidFeature.COUNTRY_CODE
ILcdDAFIFNavaidFeature.KEY_CODE
ILcdDAFIFNavaidFeature.STATE_PROVINCE_CODE
ILcdNavaidFeature.NAME
ILcdDAFIFNavaidFeature.ICAO_CODE
, ILcdDAFIFNavaidFeature.ICAO_REGION
ILcdDAFIFNavaidFeature.WORLD_AREA_CODE
ILcdDAFIFDMEFeature.FREQUENCY
, ILcdDAFIFDMEFeature.FREQUENCY_UNIT
ILcdDAFIFTACANFeature.FREQUENCY
, ILcdDAFIFTACANFeature.FREQUENCY_UNIT
ILcdNDBFeature.FREQUENCY
, ILcdNDBFeature.FREQUENCY_UNIT
ILcdVORFeature.FREQUENCY
, ILcdVORFeature.FREQUENCY_UNIT
ILcdDAFIFNavaidFeature.USAGE_CODE
ILcdDAFIFDMEFeature.CHANNEL
,
ILcdDAFIFTACANFeature.CHANNEL
ILcdDAFIFNavaidFeature.RADIO_CLASS_CODE
ILcdDAFIFNavaidFeature.FREQUENCY_PROTECTION
ILcdDAFIFNavaidFeature.POWER
, ILcdDAFIFNavaidFeature.POWER_UNIT
ILcdDAFIFNavaidFeature.RANGE
, ILcdDAFIFNavaidFeature.RANGE_UNIT
ILcdDAFIFNavaidFeature.SLAVED_VARIATION
ILcdDAFIFNavaidFeature.MAGNETIC_VARIATION
ILcdDAFIFNavaidFeature.CYCLE_DATE
Constructor and Description |
---|
TLcdDAFIFTNavaidDecoder(ALcdAISObjectFactory aDomainFactory)
Deprecated.
|
TLcdDAFIFTNavaidDecoder(TLcdAISDataObjectFactory aFactory)
Constructs a new
TLcdDAFIFTNavaidDecoder object. |
Modifier and Type | Method and Description |
---|---|
boolean |
canDecodeSource(String aSource)
Returns
true if the specified source is:
A file with the specific name corresponding to the object type of this decoder
A directory containing such a file
A .toc file in a directory, pointing to such a file
|
ILcdModel |
decode(String aSource)
Returns a model list containing one or more submodels.
|
TLcdAISDataObjectFactory |
getDataObjectFactory()
Returns the factory that is used to create domain objects.
|
String |
getDisplayName()
Returns a short, displayable name for the format that is decoded by this
ILcdModelDecoder . |
ALcdAISObjectFactory |
getDomainFactory()
Deprecated.
|
String |
getErrorMessage()
Returns the error message of the last decode call.
|
ILcdInputStreamFactory |
getInputStreamFactory()
Returns the input stream factory that is currently used for creating
the input streams for the given source names.
|
int |
getMaxNumberOfErrorReports()
Returns the number of error reports to be added to the error message.
|
ILcdDAFIFTRecordFilter |
getRecordFilter()
Returns the record filter that is currently used.
|
String[] |
getUniqueKeyFeatureNames(int aIndex)
Returns for the given submodel the array of
String objects containing the names
of the features that will be used as a unique key to insert objects into the submodel. |
void |
setDataObjectFactory(TLcdAISDataObjectFactory aFactory)
Specifies the data factory.
|
void |
setDMEDefaultDisplayNameIndex(int aIndex)
Specifies the index of the feature to be the DME display name.
|
void |
setDMEFeaturesToBeDecoded(String[] aFeaturesToBeDecoded)
Specifies the DME features to be decoded into the model objects.
|
void |
setDomainFactory(ALcdAISObjectFactory aDomainFactory)
Deprecated.
|
void |
setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory)
Sets the input stream factory that will be used for creating the
input streams for the given source names.
|
void |
setMaxNumberOfErrorReports(int aMaxNumberOfErrorReports)
Specifies a value for the maximum number of error reports.
|
void |
setNDBDefaultDisplayNameIndex(int aIndex)
Specifies the index of the feature to be the NDB display name.
|
void |
setNDBFeaturesToBeDecoded(String[] aFeaturesToBeDecoded)
Specifies the NDB features to be decoded into the model objects.
|
void |
setRecordFilter(ILcdDAFIFTRecordFilter aRecordFilter)
Specifies a filter to be used while creating the model.
|
void |
setTACANDefaultDisplayNameIndex(int aIndex)
Specifies the index of the feature to be the TACAN display name.
|
void |
setTACANFeaturesToBeDecoded(String[] aFeaturesToBeDecoded)
Specifies the TACAN features to be decoded into the model objects.
|
void |
setVORDefaultDisplayNameIndex(int aIndex)
Specifies the index of the feature to be the VOR display name.
|
void |
setVORFeaturesToBeDecoded(String[] aFeaturesToBeDecoded)
Specifies the VOR features to be decoded into the model objects.
|
getDecodingBounds, getModelFilter, setDecodingBounds, setModelFilter
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
canDecodeSource, canDecodeSource, decodeModelMetadata, decodeModelMetadata, decodeSource, discoverDataSources
@Deprecated public TLcdDAFIFTNavaidDecoder(ALcdAISObjectFactory aDomainFactory)
TLcdDAFIFTNavaidDecoder
object. The user should specify which
aDomainFactory he or she wants to use to create the navaid objects.aDomainFactory
- The factory to be used to create the model objects.public TLcdDAFIFTNavaidDecoder(TLcdAISDataObjectFactory aFactory)
TLcdDAFIFTNavaidDecoder
object. The user should specify which
factory he or she wants to use to create the navaid objects.aFactory
- The factory to be used to create the model objects.public String getDisplayName()
ILcdModelDecoder
ILcdModelDecoder
.getDisplayName
in interface ILcdModelDecoder
getDisplayName
in class ALcdDAFIFTModelDecoder
ILcdModelDecoder
.public void setVORDefaultDisplayNameIndex(int aIndex)
aIndex
- The index of the feature to be the VOR display name.public void setNDBDefaultDisplayNameIndex(int aIndex)
aIndex
- The index of the feature to be the NDB display name.public void setDMEDefaultDisplayNameIndex(int aIndex)
aIndex
- The index of the feature to be the DME display name.public void setTACANDefaultDisplayNameIndex(int aIndex)
aIndex
- The index of the feature to be the TACAN display name.public void setVORFeaturesToBeDecoded(String[] aFeaturesToBeDecoded)
IDENTIFIER
,
TYPE
, COUNTRY_CODE
and KEY_CODE
features
are in your list of features to be decoded!aFeaturesToBeDecoded
- A list of features that should be decoded into the VOR model objects.public void setNDBFeaturesToBeDecoded(String[] aFeaturesToBeDecoded)
IDENTIFIER
,
TYPE
, COUNTRY_CODE
and KEY_CODE
features
are in your list of features to be decoded!aFeaturesToBeDecoded
- A list of features that should be decoded into the NDB model objects.public void setDMEFeaturesToBeDecoded(String[] aFeaturesToBeDecoded)
IDENTIFIER
,
TYPE
, COUNTRY_CODE
and KEY_CODE
features
are in your list of features to be decoded!aFeaturesToBeDecoded
- A list of features that should be decoded into the DME model objects.public void setTACANFeaturesToBeDecoded(String[] aFeaturesToBeDecoded)
IDENTIFIER
,
TYPE
, COUNTRY_CODE
and KEY_CODE
features
are in your list of features to be decoded!aFeaturesToBeDecoded
- A list of features that should be decoded into the TACAN model objects.public ILcdModel decode(String aSource) throws IOException
getRecordFilter()
) will be decoded.
A decoded record needs to pass two additional filters (a model filter getModelFilter()
and a bounds filter getDecodingBounds()
) before
it can be added to the model.
Furthermore, an error message will be initialized and filled with reports about errors occurred
during the decode process. By default, all reports will be added into the error message. The
method setMaxNumberOfErrorReports(int)
can be used to adjust this setting.aSource
- Either the directory containing the DAFIFT source file to decode
or the DAFIFT source file itself.IOException
- if an error occurs during the reading process.ILcdModelDecoder.canDecodeSource(String)
public String[] getUniqueKeyFeatureNames(int aIndex)
String
objects containing the names
of the features that will be used as a unique key to insert objects into the submodel.aIndex
- The index of the submodel whose unique key feature names are being retrieved.public boolean canDecodeSource(String aSource)
true
if the specified source is:
.toc
file in a directory, pointing to such a fileaSource
- the name of the source file or directory that you want to decode@Deprecated public ALcdAISObjectFactory getDomainFactory()
getDataObjectFactory()
setDomainFactory(ALcdAISObjectFactory)
@Deprecated public void setDomainFactory(ALcdAISObjectFactory aDomainFactory)
setDataObjectFactory(TLcdAISDataObjectFactory)
aDomainFactory
- The factory that will be used to create domain objects.getDomainFactory()
public TLcdAISDataObjectFactory getDataObjectFactory()
setDomainFactory(ALcdAISObjectFactory)
public void setDataObjectFactory(TLcdAISDataObjectFactory aFactory)
null
, will
NOT use their associated domain factory (see getDomainFactory()
).aFactory
- The factory that will be used to create domain objects.getDomainFactory()
public ILcdInputStreamFactory getInputStreamFactory()
getInputStreamFactory
in interface ILcdInputStreamFactoryCapable
setInputStreamFactory(ILcdInputStreamFactory)
public void setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory)
setInputStreamFactory
in interface ILcdInputStreamFactoryCapable
aInputStreamFactory
- The input stream factory to be used.getInputStreamFactory()
public ILcdDAFIFTRecordFilter getRecordFilter()
setRecordFilter(ILcdDAFIFTRecordFilter)
public void setRecordFilter(ILcdDAFIFTRecordFilter aRecordFilter)
aRecordFilter
- The record filter that should be passed before a record
can be decoded.getRecordFilter()
public int getMaxNumberOfErrorReports()
setMaxNumberOfErrorReports(int)
public void setMaxNumberOfErrorReports(int aMaxNumberOfErrorReports)
aMaxNumberOfErrorReports
- The maximum number of error reports to be added to the error message.getMaxNumberOfErrorReports()
public String getErrorMessage()
String
object containing the errors occurred during
the last decode process.