com.luciad.format.dafif.decoder

Aviation StandardsInterface ILcdDAFIFDecoder

All Superinterfaces:

ILcdModelDecoder

All Known Subinterfaces:

ILcdDAFIFMultiModelDecoder

All Known Implementing Classes:

ALcdDAFIFAerodromeDecoder, ALcdDAFIFAirspaceDecoder, ALcdDAFIFDecoder, ALcdDAFIFMultiModelDecoder, ALcdDAFIFSingleModelDecoder, TLcdDAFIFAerodromeDecoder, TLcdDAFIFAerodromeNavaidDecoder, TLcdDAFIFAirspaceDecoder, TLcdDAFIFATSRouteDecoder, TLcdDAFIFHelipadDecoder, TLcdDAFIFHeliportDecoder, TLcdDAFIFHoldingDecoder, TLcdDAFIFILSDecoder, TLcdDAFIFIndependentAerodromeNavaidDecoder, TLcdDAFIFIndependentATSRouteDecoder, TLcdDAFIFIndependentHelipadDecoder, TLcdDAFIFIndependentHoldingDecoder, TLcdDAFIFIndependentILSDecoder, TLcdDAFIFIndependentProcedureDecoder, TLcdDAFIFIndependentRunwayDecoder, TLcdDAFIFMilitaryTrainingRouteDecoder, TLcdDAFIFNavaidDecoder, TLcdDAFIFOrtcaDecoder, TLcdDAFIFParachuteJumpAreaDecoder, TLcdDAFIFProcedureDecoder, TLcdDAFIFRefuelingTrackDecoder, TLcdDAFIFRunwayDecoder, TLcdDAFIFSpecialUseAirspaceDecoder, TLcdDAFIFVFRRouteDecoder, TLcdDAFIFWayPointDecoder

public interface ILcdDAFIFDecoder
extends ILcdModelDecoder

This extension of the ILcdModelDecoder interface defines the methods necessary for decoding a DAFIF data file.

Method Summary

Modifier and Type	Method and Description
ILcdBounds	getBounds() Returns the initial bounds for the model.
Properties	getDAFIFProperties() Returns a DAFIF Properties object.
TLcdAISDataObjectFactory	getDataObjectFactory() Returns the Factory to be used to create domain objects.
String	getDecodeFileName() Returns the name of the file to be decoded.
ILcdBounds	getDecodingBounds() Returns the bounds to filter on.
ALcdAISObjectFactory	getDomainFactory() Deprecated. Use getDataObjectFactory()
String	getErrorMessage() Returns the error message of the last decode call.
void	setBounds(ILcdBounds aInitialBounds) Specifies a bounds to be used as initial bounds for the model.
void	setDAFIFModelFilter(ILcdDAFIFModelFilter aFilter) Specifies a filter to be used while creating the model.
void	setDAFIFProperties(Properties aDAFIFProperties) Specifies a Properties object containing the DAFIF properties.
void	setDataObjectFactory(TLcdAISDataObjectFactory aFactory) Specifies the factory to be used to create domain objects.
void	setDecodingBounds(ILcdBounds aBoundsToFilterOn) Specifies a bounds that will be used to filter on.
void	setDomainFactory(ALcdAISObjectFactory aDomainFactory) Deprecated. Use setDataObjectFactory(TLcdAISDataObjectFactory)
void	setStoreOriginalReference(boolean aStoreReference)

Methods inherited from interface com.luciad.model.ILcdModelDecoder

canDecodeSource, canDecodeSource, decode, decodeModelMetadata, decodeModelMetadata, decodeSource, discoverDataSources, getDisplayName

Method Detail

getDecodeFileName

String getDecodeFileName()

Returns the name of the file to be decoded.

Each domain object has its own file name. This method returns the name of the data file for the domain objects decoded by this DAFIF decoder.

Returns:

the name of the source file

setBounds

void setBounds(ILcdBounds aInitialBounds)

Specifies a bounds to be used as initial bounds for the model.

This bounds should be large enough to enclose (most of) the model objects. This option is used to avoid to many expansions of the model bounds.

This parameter may be NULL.

Note: this bounds is not a filter! If a model objects bounds does not interact with aInitialBounds, aInitialBounds will be enlarged until it does interact.

Parameters:

aInitialBounds - the initial bounds for the model

See Also:

getBounds()

setDecodingBounds

void setDecodingBounds(ILcdBounds aBoundsToFilterOn)

Specifies a bounds that will be used to filter on.

If this bounds is null, all objects found in the input file will be inserted into the model.

If this bounds is not null, only the objects whose bounds interact with the specified bounds will be inserted into the model.

Parameters:

aBoundsToFilterOn - the bounds to be used as a filter

See Also:

getDecodingBounds()

setDomainFactory

@Deprecated
void setDomainFactory(ALcdAISObjectFactory aDomainFactory)

Deprecated. Use setDataObjectFactory(TLcdAISDataObjectFactory)

Specifies the domainFactory to be used to create domain objects.

The given domainFactory must not be null. Note that if a data object factory is set, the domain factory will not be used.

Parameters:

aDomainFactory - the domainFactory to be used to create domain objects

See Also:

getDomainFactory()

getDomainFactory

@Deprecated
ALcdAISObjectFactory getDomainFactory()

Deprecated. Use getDataObjectFactory()

Returns the domainFactory to be used to create domain objects.

Returns:

the domainFactory to be used to create domain objects

See Also:

setDomainFactory(com.luciad.ais.model.ALcdAISObjectFactory)

getDataObjectFactory

TLcdAISDataObjectFactory getDataObjectFactory()

Returns the Factory to be used to create domain objects.

Returns:

the factory to be used to create domain objects

See Also:

setDataObjectFactory(TLcdAISDataObjectFactory)

setDataObjectFactory

void setDataObjectFactory(TLcdAISDataObjectFactory aFactory)

Specifies the factory to be used to create domain objects.

The given factory must not be null.

Parameters:

aFactory - the domainFactory to be used to create domain objects

See Also:

getDataObjectFactory()

getErrorMessage

String getErrorMessage()

Returns the error message of the last decode call.

Note: 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

getDAFIFProperties

Properties getDAFIFProperties()

Returns a DAFIF Properties object. The DAFIF properties contain -among other things- the links between domain objects and their data file names.

Returns:

the DAFIF Properties object that is used to retrieve the decode file name from

See Also:

setDAFIFProperties(java.util.Properties)

setDAFIFProperties

void setDAFIFProperties(Properties aDAFIFProperties)

Specifies a Properties object containing the DAFIF properties. This object should contain for each domain object its data file name (e.g. source.refuelingTracksFile=FILE7).

Parameters:

aDAFIFProperties - a Properties object containing the DAFIF properties

See Also:

getDAFIFProperties(), TLcdDAFIFDataPreparatorMain

getBounds

ILcdBounds getBounds()

Returns the initial bounds for the model.

Returns:

the initial bounds for the model

See Also:

setBounds(com.luciad.shape.ILcdBounds)

getDecodingBounds

ILcdBounds getDecodingBounds()

Returns the bounds to filter on.

Returns:

the bounds to be filtered on

See Also:

setDecodingBounds(com.luciad.shape.ILcdBounds)

setDAFIFModelFilter

void setDAFIFModelFilter(ILcdDAFIFModelFilter aFilter)

Specifies a filter to be used while creating the model. Only model objects that pass through the filter will be in the resulting model.

Parameters:

aFilter - an ILcdDAFIFModelFilter to filter the model objects

setStoreOriginalReference

void setStoreOriginalReference(boolean aStoreReference)