public class TLcdDAFIFTProcedureDecoder extends ALcdDAFIFTModelDecoder
ILcdModelDecoder
that decodes DAFIFT procedure objects from the
specified source directory. The decoded models have as model descriptor an instance of
TLcdDAFIFProcedureTrajectoryModelDescriptor
.
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.Procedure
,
which can also be retrieved through ILcdDataObject.getDataType()
.
The available properties of the objects are defined in TLcdDAFIFTProcedureDataProperties
.
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 setProcedureFeaturesToBeDecoded
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.
ILcdDAFIFProcedureFeature.AERODROME_IDENTIFIER
ILcdDAFIFProcedureFeature.TYPE
ILcdProcedureFeature.DESIGNATOR
ILcdDAFIFProcedureFeature.ICAO_CODE
ILcdDAFIFProcedureFeature.CYCLE_DATE
TLcdDAFIFTProcedureDecoder
class does not decode the model
objects necessary to construct the procedures. The models should be specified using the appropriate
setModel
methods.
To identify the model objects uniquely within the waypoint model, a unique index on the key features
is added in the setModel
methods. The used key features are:
ILcdDAFIFProcedureFeature
,
TLcdDAFIFProcedureTrajectoryModelDescriptor
Constructor and Description |
---|
TLcdDAFIFTProcedureDecoder(ALcdAISObjectFactory aDomainFactory)
Deprecated.
|
TLcdDAFIFTProcedureDecoder(TLcdAISDataObjectFactory aDataFactory)
Constructs a new
TLcdDAFIFTProcedureDecoder 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)
Checks whether a airport 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.
|
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()
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 |
setAirportModel(ILcdFeatureIndexedModel aAirportModel)
Specifies the model containing the aerodrome objects this decoder should use.
|
void |
setDataObjectFactory(TLcdAISDataObjectFactory aFactory)
Specifies the data factory.
|
void |
setDomainFactory(ALcdAISObjectFactory aDomainFactory)
Deprecated.
|
void |
setHeliportModel(ILcdFeatureIndexedModel aHeliportModel)
Specifies the model containing the heliport objects this decoder should use.
|
void |
setILSModel(TLcdModelList aILSModel)
Specifies the model list containing the ILS objects this decoder should use.
|
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 |
setProcedureDefaultDisplayNameIndex(int aIndex)
Specifies the index of the feature to be the procedure display name.
|
void |
setProcedureFeaturesToBeDecoded(String[] aFeaturesToBeDecoded)
Specifies the procedure features to be decoded into the model objects.
|
void |
setRecordFilter(ILcdDAFIFTRecordFilter aRecordFilter)
Specifies a filter to be used while creating the model.
|
void |
setRunwayModel(ILcdFeatureIndexedModel aRunwayModel)
Specifies the model containing the runway objects this decoder should use.
|
void |
setWaypointModel(ILcdFeatureIndexedModel aWaypointModel)
Specifies the model containing the waypoint objects this decoder should use.
|
getDecodingBounds, getModelFilter, setDecodingBounds, setModelFilter
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
canDecodeSource, canDecodeSource, decodeModelMetadata, decodeModelMetadata, decodeSource, discoverDataSources
@Deprecated public TLcdDAFIFTProcedureDecoder(ALcdAISObjectFactory aDomainFactory)
TLcdDAFIFTProcedureDecoder
object. The user should specify which
aDomainFactory he or she wants to use to create the procedures.aDomainFactory
- The factory to be used to create the model objects.public TLcdDAFIFTProcedureDecoder(TLcdAISDataObjectFactory aDataFactory)
TLcdDAFIFTProcedureDecoder
object. The user should specify which
factory he or she wants to use to create the procedures.aDataFactory
- 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 ILcdModel decode(String aSource) throws IOException
IllegalStateException
object will be thrown.
Returns a model containing the domain objects read from the given source file.
The model 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.decode
in interface ILcdModelDecoder
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.IllegalStateException
- if no airport model has been specified.ILcdModelDecoder.canDecodeSource(String)
public void setProcedureDefaultDisplayNameIndex(int aIndex)
aIndex
- The index of the feature to be the procedure display name.public void setProcedureFeaturesToBeDecoded(String[] aFeaturesToBeDecoded)
DESIGNATOR
,
AERODROME_IDENTIFIER
and TYPE
features are in your list
of features to be decoded!aFeaturesToBeDecoded
- A list of features that should be decoded into the procedure model objects.public void setAirportModel(ILcdFeatureIndexedModel aAirportModel)
aAirportModel
- A model containing aerodrome objects.public void setHeliportModel(ILcdFeatureIndexedModel aHeliportModel)
aHeliportModel
- A model containing heliport objects.public void setWaypointModel(ILcdFeatureIndexedModel aWaypointModel)
aWaypointModel
- A model containing waypoint objects.public void setRunwayModel(ILcdFeatureIndexedModel aRunwayModel)
aRunwayModel
- A model containing runway objects.public void setNavaidModel(TLcdModelList aNavaidModel)
aNavaidModel
- A model list containing navaid objects.public void setILSModel(TLcdModelList aILSModel)
aILSModel
- A model list containing ILS objects.public String[] getUniqueKeyFeatureNames()
String
objects containing the names of the features
that will be used as a unique key to insert objects into the model.String
objects containing the names of the features
that will be used as a unique key to insert objects into the model.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.