com.luciad.format.dafift.decoder

Aviation StandardsClass TLcdDAFIFTAerodromeNavaidDecoder

java.lang.Object

com.luciad.format.dafift.decoder.ALcdDAFIFTModelDecoder

com.luciad.format.dafift.decoder.TLcdDAFIFTAerodromeNavaidDecoder

All Implemented Interfaces:

ILcdInputStreamFactoryCapable, ILcdModelDecoder

Direct Known Subclasses:

TLcdDAFIFTIndependentAerodromeNavaidDecoder

public class TLcdDAFIFTAerodromeNavaidDecoder
extends ALcdDAFIFTModelDecoder

Implementation of 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 TLcdDAFIFAerodromeNavaidModelListDescriptor. This model list descriptor contains instances of the descriptor TLcdDAFIFDMEModelDescriptor, TLcdDAFIFVORModelDescriptor, TLcdDAFIFNDBModelDescriptor and/or TLcdDAFIFTACANModelDescriptor, dependent of the source directory.

The navaid objects produced by this decoder are a subset from the collection of navaids decoded by the TLcdDAFIFTNavaidDecoder. To be in the subset, a navaid should:

• have the same name as the airport or heliport it belongs to,
• be located on the airport or heliport it belongs to (and have a different name) and
• be used to furnish final approach procedure guidance on an IAP serving the airport or heliport it belongs to.

The TLcdDAFIFTAerodromeNavaidDecoder won't create navaids itself. It will retrieve the navaids for its model from the specified navaid model. This navaid model should be set by using the setNavaidModel method. The model should have an index on some key features that uniquely define the objects. For navaids the key features are:

• ILcdNavaidFeature.IDENTIFIER
• ILcdDAFIFNavaidFeature.TYPE
• ILcdDAFIFNavaidFeature.COUNTRY_CODE
• ILcdDAFIFNavaidFeature.KEY_CODE

A unique key with the features mentioned above is added on the aerodrome navaid model. The features should be decoded into the featured model objects of the aerodrome navaid model.

Since:

7.2

See Also:

TLcdDAFIFTNavaidDecoder, TLcdDAFIFAerodromeNavaidModelListDescriptor, TLcdDAFIFDMEModelDescriptor, TLcdDAFIFVORModelDescriptor, TLcdDAFIFNDBModelDescriptor, TLcdDAFIFTACANModelDescriptor

Constructor Summary

Constructors

Constructor and Description
TLcdDAFIFTAerodromeNavaidDecoder(ALcdAISObjectFactory aDomainFactory) Deprecated.
TLcdDAFIFTAerodromeNavaidDecoder(TLcdAISDataObjectFactory aFactory) Constructs a new TLcdDAFIFTAerodromeNavaidDecoder object.

Method Summary

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) Checks whether a navaid model is set before starting the decode process.
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. Use getDataObjectFactory()
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	setDomainFactory(ALcdAISObjectFactory aDomainFactory) Deprecated. Use setDataObjectFactory(TLcdAISDataObjectFactory)
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	setNavaidModel(TLcdModelList aNavaidModel) Specifies the model list containing the navaid objects this decoder should use.
void	setNDBDefaultDisplayNameIndex(int aIndex) Specifies the index of the feature to be the NDB display name.
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	setVORDefaultDisplayNameIndex(int aIndex) Specifies the index of the feature to be the VOR display name.

Methods inherited from class com.luciad.format.dafift.decoder.ALcdDAFIFTModelDecoder

getDecodingBounds, getModelFilter, setDecodingBounds, setModelFilter

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.model.ILcdModelDecoder

canDecodeSource, canDecodeSource, decodeModelMetadata, decodeModelMetadata, decodeSource, discoverDataSources

Constructor Detail

TLcdDAFIFTAerodromeNavaidDecoder

@Deprecated
public TLcdDAFIFTAerodromeNavaidDecoder(ALcdAISObjectFactory aDomainFactory)

Deprecated.

Constructs a new TLcdDAFIFTAerodromeNavaidDecoder object. The aDomainFactory specified here, may be null.

Parameters:

aDomainFactory - The factory to be used to create the model objects.

TLcdDAFIFTAerodromeNavaidDecoder

public TLcdDAFIFTAerodromeNavaidDecoder(TLcdAISDataObjectFactory aFactory)

Constructs a new TLcdDAFIFTAerodromeNavaidDecoder object. The factory specified here, may be null.

Parameters:

aFactory - The factory to be used to create the model objects.

Method Detail

getDisplayName

public String getDisplayName()

Description copied from interface: ILcdModelDecoder

Returns a short, displayable name for the format that is decoded by this ILcdModelDecoder.

Specified by:

getDisplayName in interface ILcdModelDecoder

Overrides:

getDisplayName in class ALcdDAFIFTModelDecoder

Returns:

the displayable name of this ILcdModelDecoder.

decode

public ILcdModel decode(String aSource)
                 throws IOException

Checks whether a navaid model is set before starting the decode process. If no navaid model is specified, an IllegalStateException object will be thrown.

Returns a model list containing one or more submodels. Each submodel contains domain objects of the same type.

The models will be build by looping through the records found in the source file. Each record that passes the record filter (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.

Specified by:

decode in interface ILcdModelDecoder

Parameters:

aSource - Either the directory containing the DAFIFT source file to decode or the DAFIFT source file itself.

Returns:

the model build by reading the file found with the given source.

Throws:

IOException - if an error occurs during the reading process.

IllegalStateException - if no navaid model has been specified.

See Also:

ILcdModelDecoder.canDecodeSource(String)

setVORDefaultDisplayNameIndex

public void setVORDefaultDisplayNameIndex(int aIndex)

Specifies the index of the feature to be the VOR display name.

Parameters:

aIndex - The index of the feature to be the VOR display name.

setNDBDefaultDisplayNameIndex

public void setNDBDefaultDisplayNameIndex(int aIndex)

Specifies the index of the feature to be the NDB display name.

Parameters:

aIndex - The index of the feature to be the NDB display name.

setDMEDefaultDisplayNameIndex

public void setDMEDefaultDisplayNameIndex(int aIndex)

Specifies the index of the feature to be the DME display name.

Parameters:

aIndex - The index of the feature to be the DME display name.

setTACANDefaultDisplayNameIndex

public void setTACANDefaultDisplayNameIndex(int aIndex)

Specifies the index of the feature to be the TACAN display name.

Parameters:

aIndex - The index of the feature to be the TACAN display name.

setNavaidModel

public void setNavaidModel(TLcdModelList aNavaidModel)

Specifies the model list containing the navaid objects this decoder should use.

Parameters:

aNavaidModel - A model list containing navaid objects.

getUniqueKeyFeatureNames

public 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.

Parameters:

aIndex - The index of the submodel whose unique key feature names are being retrieved.

Returns:

for the given submodel the unique key feature names.

canDecodeSource

public 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

Parameters:

aSource - the name of the source file or directory that you want to decode

Returns:

a boolean indicating whether the given source can be decoded

getDomainFactory

@Deprecated
public ALcdAISObjectFactory getDomainFactory()

Deprecated. Use getDataObjectFactory()

Returns the factory that is used to create domain objects.

Returns:

the factory that is used to create domain objects.

See Also:

setDomainFactory(ALcdAISObjectFactory)

setDomainFactory

@Deprecated
public void setDomainFactory(ALcdAISObjectFactory aDomainFactory)

Deprecated. Use setDataObjectFactory(TLcdAISDataObjectFactory)

Specifies the domain factory.

The domain factory will be used to create the domain objects decoded by this DAFIFT decoder.

Parameters:

aDomainFactory - The factory that will be used to create domain objects.

See Also:

getDomainFactory()

getDataObjectFactory

public TLcdAISDataObjectFactory getDataObjectFactory()

Returns the factory that is used to create domain objects.

Returns:

the factory that is used to create domain objects.

See Also:

setDomainFactory(ALcdAISObjectFactory)

setDataObjectFactory

public void setDataObjectFactory(TLcdAISDataObjectFactory aFactory)

Specifies the data factory.

The data factory will be used to create the domain objects decoded by this DAFIFT decoder.

Decoders equipped with a data object factory that is not null, will NOT use their associated domain factory (see getDomainFactory()).

Parameters:

aFactory - The factory that will be used to create domain objects.

See Also:

getDomainFactory()

getInputStreamFactory

public ILcdInputStreamFactory getInputStreamFactory()

Returns the input stream factory that is currently used for creating the input streams for the given source names.

Specified by:

getInputStreamFactory in interface ILcdInputStreamFactoryCapable

Returns:

the input stream factory that is currently used.

See Also:

setInputStreamFactory(ILcdInputStreamFactory)

setInputStreamFactory

public void setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory)

Sets the input stream factory that will be used for creating the input streams for the given source names.

Specified by:

setInputStreamFactory in interface ILcdInputStreamFactoryCapable

Parameters:

aInputStreamFactory - The input stream factory to be used.

See Also:

getInputStreamFactory()

getRecordFilter

public ILcdDAFIFTRecordFilter getRecordFilter()

Returns the record filter that is currently used.

Returns:

the record filter that is currently used.

See Also:

setRecordFilter(ILcdDAFIFTRecordFilter)

setRecordFilter

public void setRecordFilter(ILcdDAFIFTRecordFilter aRecordFilter)

Specifies a filter to be used while creating the model. Only records that pass through this filter will be decoded into model objects.

Parameters:

aRecordFilter - The record filter that should be passed before a record can be decoded.

See Also:

getRecordFilter()

getMaxNumberOfErrorReports

public int getMaxNumberOfErrorReports()

Returns the number of error reports to be added to the error message. If there are more errors than the maxNumberOfErrorReports property, they won't be stored and you won't be able to see these errors in the error message after the decoding process.

Returns:

the number of error reports to be added to the error message.

See Also:

setMaxNumberOfErrorReports(int)

setMaxNumberOfErrorReports

public void setMaxNumberOfErrorReports(int aMaxNumberOfErrorReports)

Specifies a value for the maximum number of error reports. If a negative value is set, all reported errors will be added to the error message.

Parameters:

aMaxNumberOfErrorReports - The maximum number of error reports to be added to the error message.

See Also:

getMaxNumberOfErrorReports()

getErrorMessage

public String getErrorMessage()

Returns the error message of the last decode call.

Note that the error message can only be retrieved once after a decode call.

Returns:

a String object containing the errors occurred during the last decode process.