com.luciad.format.dafift.decoder

Aviation StandardsClass TLcdDAFIFTSpecialUseAirspaceDecoder

java.lang.Object

com.luciad.format.dafift.decoder.ALcdDAFIFTModelDecoder

com.luciad.format.dafift.decoder.TLcdDAFIFTSpecialUseAirspaceDecoder

All Implemented Interfaces:

ILcdDAFIFSubTypeFilteringDecoder, ILcdInputStreamFactoryCapable, ILcdModelDecoder

public class TLcdDAFIFTSpecialUseAirspaceDecoder
extends ALcdDAFIFTModelDecoder
implements ILcdDAFIFSubTypeFilteringDecoder

Implementation of ILcdModelDecoder that decodes DAFIFT special use airspace objects from the specified source directory. The decoded models have as model descriptor an instance of TLcdDAFIFSpecialUseAirspaceModelDescriptor. If subtype filtering is enabled (via setSubTypesToDecode(int[])), the decoder will produce a TLcdModelList with a TLcdDAFIFSpecialUseAirspaceModelListDescriptor. Each element of this model list will contain objects of one of the selected subtypes. The number of models in the list, in other words, will equal the number of chosen subtypes.

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 decoder, the type of the decoded objects is TLcdDAFIFTDataTypes.SpecialUseAirspace, which can also be retrieved through ILcdDataObject.getDataType(). The available properties of the objects are defined in TLcdDAFIFTSpecialUseAirspaceDataProperties. 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 setAirspaceFeaturesToBeDecoded method allows the user to specify which DAFIFT features are to be decoded into the featured model objects. If no features are specified, all features will be decoded.

The following fields (which are taken from the National Imagery and Mapping Agency (NIMA) Product Specifications for Digital Aeronautical Flight Information File (DAFIF), Eight Edition, January 2005) are supported by the decoder. The list indicates into which feature the fields are decoded.

• BOUNDARY IDENTIFICATION: ILcdDAFIFAirspaceFeature.BOUNDARY_IDENTIFICATION
• SECTOR: ILcdDAFIFAirspaceFeature.SECTOR
• NAME: ILcdAirspaceFeature.NAME
• ICAO CODE: ILcdDAFIFAirspaceFeature.ICAO_CODE, ILcdDAFIFAirspaceFeature.ICAO_REGION
• CONTROLLING AUTHORITY: ILcdDAFIFAirspaceFeature.CONTROLLING_AGENCY
• COMMUNICATIONS NAME: ILcdDAFIFAirspaceFeature.COMMUNICATIONS_NAME
• COMMUNICATIONS FREQUENCY 1: ILcdDAFIFAirspaceFeature.COMMUNICATIONS_FREQUENCY1
• COMMUNICATIONS FREQUENCY 2: ILcdDAFIFAirspaceFeature.COMMUNICATIONS_FREQUENCY2
• LEVEL: ILcdDAFIFAirspaceFeature.LEVEL
• UPPER EFFECTIVE ALTITUDE: ILcdAirspaceFeature.UPPER_LIMIT, ILcdAirspaceFeature.UPPER_LIMIT_UNIT, ILcdAirspaceFeature.UPPER_LIMIT_REFERENCE
• LOWER EFFECTIVE ALTITUDE: ILcdAirspaceFeature.LOWER_LIMIT, ILcdAirspaceFeature.LOWER_LIMIT_UNIT, ILcdAirspaceFeature.LOWER_LIMIT_REFERENCE
• EFFECTIVE TIMES: ILcdDAFIFAirspaceFeature.EFFECTIVE_TIMES
• WEATHER: ILcdDAFIFAirspaceFeature.WEATHER
• EFFECTIVE DATE: ILcdDAFIFAirspaceFeature.EFFECTIVE_DATE
• CYCLE DATE: ILcdDAFIFAirspaceFeature.CYCLE_DATE

All DAFIFT decoders rely on a specific set of key features that uniquely define an object. This set of features must always be included in the set of features to be decoded. For special use airspaces, the key features are:

• ILcdDAFIFAirspaceFeature.BOUNDARY_IDENTIFICATION
• ILcdDAFIFAirspaceFeature.SECTOR

Since:

7.2

See Also:

ILcdDAFIFAirspaceFeature, TLcdDAFIFSpecialUseAirspaceModelDescriptor

Constructor Summary

Constructors

Constructor and Description
TLcdDAFIFTSpecialUseAirspaceDecoder(ALcdAISObjectFactory aDomainFactory) Deprecated.
TLcdDAFIFTSpecialUseAirspaceDecoder(TLcdAISDataObjectFactory aFactory) Constructs a new TLcdDAFIFTSpecialUseAirspaceDecoder 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 aSourceName) Decode the given source and return a TLcdModelList with a submodel per decoded subtype.
Object[]	getAvailableSubTypes() Get an array of enumerated values defining all subtypes of a given DAFIF feature type.
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.
int[]	getSubTypesToDecode() Returns the set of special use airspace types to be decoded.
String[]	getUniqueKeyFeatureNames() Returns the array of String objects containing the names of the features that will be used as a unique key to insert objects into the model.
void	setAirspaceDefaultDisplayNameIndex(int aIndex) Specifies the index of the feature to be the airspace display name.
void	setAirspaceFeaturesToBeDecoded(String[] aFeaturesToBeDecoded) Specifies the airspace features to be decoded into the model objects.
void	setAirspaceTypeToFilter(TLcdAirspaceType aAirspaceTypeToFilter) Sets the airspace type to be filtered on.
void	setDataObjectFactory(TLcdAISDataObjectFactory aFactory) Specifies the data factory.
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	setModelFilter(ILcdDAFIFModelFilter aFilter) Set the model filter of this decoder.
void	setRecordFilter(ILcdDAFIFTRecordFilter aRecordFilter) Specifies a filter to be used while creating the model.
void	setSubTypesToDecode(int[] aSubTypeIndices) Set the set of special use airspace types to be decoded.

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

getDecodingBounds, getModelFilter, setDecodingBounds

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

TLcdDAFIFTSpecialUseAirspaceDecoder

@Deprecated
public TLcdDAFIFTSpecialUseAirspaceDecoder(ALcdAISObjectFactory aDomainFactory)

Deprecated.

Constructs a new TLcdDAFIFTSpecialUseAirspaceDecoder object. The user should specify which aDomainFactory he or she wants to use to create the special use airspaces.

Parameters:

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

TLcdDAFIFTSpecialUseAirspaceDecoder

public TLcdDAFIFTSpecialUseAirspaceDecoder(TLcdAISDataObjectFactory aFactory)

Constructs a new TLcdDAFIFTSpecialUseAirspaceDecoder object. The user should specify which aDomainFactory he or she wants to use to create the special use airspaces.

Parameters:

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

Method Detail

getAvailableSubTypes

public Object[] getAvailableSubTypes()

Get an array of enumerated values defining all subtypes of a given DAFIF feature type. Note : This array MUST NOT be modified. See setSubTypesToDecode(int[]).

Specified by:

getAvailableSubTypes in interface ILcdDAFIFSubTypeFilteringDecoder

Returns:

an array of enumerated values defining subtypes of a given DAFIF feature type.

setSubTypesToDecode

public void setSubTypesToDecode(int[] aSubTypeIndices)

Set the set of special use airspace types to be decoded.

Specified by:

setSubTypesToDecode in interface ILcdDAFIFSubTypeFilteringDecoder

Parameters:

aSubTypeIndices - an array of indices specifying which type of airspace will be decoded. If null is passed, reset to the default types.

getSubTypesToDecode

public int[] getSubTypesToDecode()

Returns the set of special use airspace types to be decoded.

Specified by:

getSubTypesToDecode in interface ILcdDAFIFSubTypeFilteringDecoder

Returns:

the set of special use airspace types to be decoded.

setAirspaceTypeToFilter

public void setAirspaceTypeToFilter(TLcdAirspaceType aAirspaceTypeToFilter)

Sets the airspace type to be filtered on. If this filter is set, the decode method will only put airspaces of the chosen type in the decoded model.

If aAirspaceTypeToFilter is null, the decode method will put all airspaces in the model.

Parameters:

aAirspaceTypeToFilter - The airspace type to be filtered on.

setModelFilter

public void setModelFilter(ILcdDAFIFModelFilter aFilter)

Set the model filter of this decoder. The given filter is combined to the airspace type filtering.

Overrides:

setModelFilter in class ALcdDAFIFTModelDecoder

Parameters:

aFilter - The model filter that should be passed before a model object is added to the resulting model.

See Also:

ALcdDAFIFTModelDecoder.getModelFilter()

decode

public ILcdModel decode(String aSourceName)
                 throws IOException

Decode the given source and return a TLcdModelList with a submodel per decoded subtype.

Specified by:

decode in interface ILcdModelDecoder

Parameters:

aSourceName - a DAFIF edition 8 source name

Returns:

a TLcdModelList with one model per decoded subtype.

Throws:

IOException - if the decoding cannot complete.

See Also:

ILcdModelDecoder.canDecodeSource(String)

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.

setAirspaceFeaturesToBeDecoded

public void setAirspaceFeaturesToBeDecoded(String[] aFeaturesToBeDecoded)

Specifies the airspace features to be decoded into the model objects.

Please add the BOUNDARY_IDENTIFICATION and SECTOR features to your list. These features corresponds to the unique key feature name of an airspace model object.

If you want to filter on an airspace type, you should also include the airspace feature ILcdAirspaceFeature.TYPE into your list.

Parameters:

aFeaturesToBeDecoded - A list of features that should be decoded into the special use airspace model objects.

setAirspaceDefaultDisplayNameIndex

public void setAirspaceDefaultDisplayNameIndex(int aIndex)

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

Parameters:

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

getUniqueKeyFeatureNames

public String[] getUniqueKeyFeatureNames()

Returns the array of String objects containing the names of the features that will be used as a unique key to insert objects into the model.

Returns:

the array of String objects containing the names of the features that will be used as a unique key to insert objects into the model.

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.