Package com.luciad.format.s57

Class TLcdS57CatalogueModelDescriptor

java.lang.Object
com.luciad.model.TLcdModelDescriptor
com.luciad.format.s57.TLcdS57CatalogueModelDescriptor
All Implemented Interfaces:
ILcdDataModelDescriptor, ILcdDataSourceModelDescriptor, ILcdModelDescriptor, ILcdFeaturedDescriptorProvider, Serializable
public class TLcdS57CatalogueModelDescriptor extends TLcdModelDescriptor implements ILcdDataModelDescriptor, ILcdFeaturedDescriptorProvider, ILcdDataSourceModelDescriptor
This ILcdModelDescriptor describes decoded S-57 catalogues.
See Also:

  • Field Details

    • TYPE_NAME

      public static final String TYPE_NAME
      Type name identifying the S-57 catalogue format type.
      See Also:

  • Constructor Details

    • TLcdS57CatalogueModelDescriptor

      public TLcdS57CatalogueModelDescriptor(String aSourceName, String aDisplayName)
      Deprecated.
      Use the constructor with data model parameters instead.
      Creates a new TLcdS57CatalogueModelDescriptor.
      Parameters:
      aSourceName - the name of the data source.
      aDisplayName - the display name of the data source.

    • TLcdS57CatalogueModelDescriptor

      public TLcdS57CatalogueModelDescriptor(String aSourceName, String aDisplayName, TLcdDataModel aDataModel, Set<TLcdDataType> aModelElementTypes, Set<TLcdDataType> aModelTypes)
      Creates a new S-57 catalogue model descriptor.
      Parameters:
      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.

    • TLcdS57CatalogueModelDescriptor

      public TLcdS57CatalogueModelDescriptor(TLcdS57CatalogueDataSource aDataSource, String aDisplayName, TLcdDataModel aDataModel, Set<TLcdDataType> aModelElementTypes, Set<TLcdDataType> aModelTypes)
      Creates a new S-57 catalogue model descriptor.
      Parameters:
      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.

  • Method Details

    • getDataSource

      public ILcdDataSource getDataSource()
      Description copied from interface: ILcdDataSourceModelDescriptor
      Returns the object that was used to decode the corresponding model.
      Specified by:
      getDataSource in interface ILcdDataSourceModelDescriptor
      Returns:
      an object describing the data source(s) of the corresponding model. This can be null, e.g. when the model was not decoded by using an ILcdDataSource.
      See Also:

    • getDataModel

      public TLcdDataModel getDataModel()
      Description copied from interface: ILcdDataModelDescriptor

      Returns 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)).

      Specified by:
      getDataModel in interface ILcdDataModelDescriptor
      Returns:
      the data model that describes the elements of the model

    • getModelElementTypes

      public Set<TLcdDataType> getModelElementTypes()
      Description copied from interface: ILcdDataModelDescriptor

      Returns 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() ).

      Specified by:
      getModelElementTypes in interface ILcdDataModelDescriptor
      Returns:
      a set containing all the data types of which instances can be elements in the model associated with this descriptor

    • getModelTypes

      public Set<TLcdDataType> getModelTypes()
      Description copied from interface: ILcdDataModelDescriptor

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

      Specified by:
      getModelTypes in interface ILcdDataModelDescriptor
      Returns:
      a set containing all the data types of which instances can be used in the model associated with this descriptor

    • getFeaturedDescriptor

      public ILcdFeaturedDescriptor getFeaturedDescriptor(ILcdFeatured aFeatured)
      Description copied from interface: ILcdFeaturedDescriptorProvider
      Gets a ILcdFeaturedDescriptor that describes the ILcdFeatured passed.
      Specified by:
      getFeaturedDescriptor in interface ILcdFeaturedDescriptorProvider
      Parameters:
      aFeatured - a featured object to retrieve a featured descriptor for.
      Returns:
      a ILcdFeaturedDescriptor that describes the ILcdFeatured passed.