public class TLcdS57CatalogueModelDescriptor extends TLcdModelDescriptor implements ILcdDataModelDescriptor,ILcdFeaturedDescriptorProvider, ILcdDataSourceModelDescriptor
ILcdModelDescriptor describes decoded S-57 catalogues.| Modifier and Type | Field and Description |
|---|---|
static String |
TYPE_NAME
Type name identifying the S-57 catalogue format type.
|
| Constructor and Description |
|---|
TLcdS57CatalogueModelDescriptor(String aSourceName,
String aDisplayName)
Deprecated.
Use the constructor with data model parameters instead.
|
TLcdS57CatalogueModelDescriptor(String aSourceName,
String aDisplayName,
TLcdDataModel aDataModel,
Set<TLcdDataType> aModelElementTypes,
Set<TLcdDataType> aModelTypes)
Creates a new S-57 catalogue model descriptor.
|
TLcdS57CatalogueModelDescriptor(TLcdS57CatalogueDataSource aDataSource,
String aDisplayName,
TLcdDataModel aDataModel,
Set<TLcdDataType> aModelElementTypes,
Set<TLcdDataType> aModelTypes)
Creates a new S-57 catalogue model descriptor.
|
| Modifier and Type | Method and Description |
|---|---|
TLcdDataModel |
getDataModel()
Returns the data model that describes the elements of the model.
|
ILcdDataSource |
getDataSource()
Returns the object that was used to decode the corresponding model.
|
ILcdFeaturedDescriptor |
getFeaturedDescriptor(ILcdFeatured aFeatured)
Gets a
ILcdFeaturedDescriptor that describes the ILcdFeatured passed. |
Set<TLcdDataType> |
getModelElementTypes()
Returns a set containing all the data types of which instances can be elements in the model
associated with this descriptor.
|
Set<TLcdDataType> |
getModelTypes()
Returns a set containing all the types of which instances can be used (including both
top-level elements and child objects) in the model associated with this descriptor.
|
getDisplayName, getSourceName, getTypeName, setDisplayName, setSourceName, setTypeName, sourceNameToDisplayNameclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetDisplayName, getSourceName, getTypeNamepublic static final String TYPE_NAME
public TLcdS57CatalogueModelDescriptor(String aSourceName, String aDisplayName)
aSourceName - the name of the data source.aDisplayName - the display name of the data source.public TLcdS57CatalogueModelDescriptor(String aSourceName, String aDisplayName, TLcdDataModel aDataModel, Set<TLcdDataType> aModelElementTypes, Set<TLcdDataType> aModelTypes)
aSourceName - the name of the data source.aDisplayName - the display name of the data source.aDataModel - the data model describing the structure of the model.aModelElementTypes - set containing all the data types of which instances occur as
elements in the model.aModelTypes - set containing all the types of which instances occur (including
both
top-level elements and child objects) in the model.public TLcdS57CatalogueModelDescriptor(TLcdS57CatalogueDataSource aDataSource, String aDisplayName, TLcdDataModel aDataModel, Set<TLcdDataType> aModelElementTypes, Set<TLcdDataType> aModelTypes)
aDataSource - the data source providing the sources from which the model was constructed.aDisplayName - the display name of the data source.aDataModel - the data model describing the structure of the model.aModelElementTypes - set containing all the data types of which instances occur as
elements in the model.aModelTypes - set containing all the types of which instances occur (including
both
top-level elements and child objects) in the model.public ILcdDataSource getDataSource()
ILcdDataSourceModelDescriptorgetDataSource in interface ILcdDataSourceModelDescriptornull, e.g. when the model
was not decoded by using an ILcdDataSource.ILcdModelDecoderpublic TLcdDataModel getDataModel()
ILcdDataModelDescriptorReturns the data model that describes the elements of the model. Note that not necessarily all data in the model will be of a type of this data model. Very likely, types from the dependencies of the returned data model are used as well.
In case the model accepts objects from multiple data models, an anonymous
data model that depends on all these data models should be returned
(see TLcdDataModelBuilder.createAnonymousDataModel(java.util.Collection)).
getDataModel in interface ILcdDataModelDescriptorpublic Set<TLcdDataType> getModelElementTypes()
ILcdDataModelDescriptorReturns a set containing all the data types of which instances can be elements in the model associated with this descriptor. Implementations are free to limit the result to only include the types of which there are actually elements in the model; but they are not required to do so.
Implementations should return null in case they don't know
which element types are present in the model.
For each element of the model associated with this model descriptor, the following holds true :
getModelElementTypes().contains( element.getDataType() ).
getModelElementTypes in interface ILcdDataModelDescriptorpublic Set<TLcdDataType> getModelTypes()
ILcdDataModelDescriptorReturns a set containing all the types of which instances can be used (including both top-level elements and child objects) in the model associated with this descriptor. Implementations are free to limit the result to only include the types of which there are actually instances in the model; but they are not required to do so.
A simple and correct implementation would be to return
getDataModel().getTypes(). Implementations are encouraged to return a subset of
this set if they can do so without spending an unreasonable amount of resources.
Implementations should return null in case they don't know
which types are present in the model.
getModelTypes in interface ILcdDataModelDescriptorpublic ILcdFeaturedDescriptor getFeaturedDescriptor(ILcdFeatured aFeatured)
ILcdFeaturedDescriptorProviderILcdFeaturedDescriptor that describes the ILcdFeatured passed.getFeaturedDescriptor in interface ILcdFeaturedDescriptorProvideraFeatured - a featured object to retrieve a featured descriptor for.ILcdFeaturedDescriptor that describes the ILcdFeatured passed.