Package com.luciad.format.gdf

Class TLcdGDFDatasetModelDescriptor

java.lang.Object
com.luciad.model.TLcdModelDescriptor
com.luciad.format.gdf.TLcdGDFDatasetModelDescriptor
All Implemented Interfaces:
ILcdDataModelDescriptor, ILcdModelDescriptor, Serializable
public class TLcdGDFDatasetModelDescriptor extends TLcdModelDescriptor
This ILcdModelDescriptor describes GDF models on the dataset level.
Since:
5.1
See Also:

  • Method Details

    • getInternationalDatasetIdentifier

      public String getInternationalDatasetIdentifier()
      Returns the international dataset identification number of this dataset.
      Returns:
      the international dataset identification number of this dataset.

    • getDatasetKey

      public TLcdGDFDatasetKey getDatasetKey()
      Returns the dataset key of this model.
      Returns:
      the dataset key of this model.

    • getLanguageCount

      public int getLanguageCount()
      Returns the number of languages used in the dataset.
      Returns:
      the number of languages used in the dataset.

    • getLanguage

      public TLcdGDFLanguage getLanguage(int aIndex)
      Returns the language at the given index.
      Parameters:
      aIndex - the index of the language to be returned.
      Returns:
      the language at the given index.
      Throws:
      IndexOutOfBoundsException - if aIndex < 0 || aIndex >= getLanguageCount().

    • getCountryCount

      public int getCountryCount()
      Returns the number of countries involved in the dataset.
      Returns:
      the number of countries involved in the dataset.

    • getCountry

      public TLcdGDFCountry getCountry(int aIndex)
      Returns the country at the given index.
      Parameters:
      aIndex - the index of the country to be returned.
      Returns:
      the country at the given index.
      Throws:
      IndexOutOfBoundsException - if aIndex < 0 || aIndex >= getCountryCount().

    • getAttributeTypeCount

      public int getAttributeTypeCount()
      Returns the number of attribute types involved in the dataset.
      Returns:
      the number of attribute types involved in the dataset.

    • getAttributeType

      public TLcdGDFAttributeType getAttributeType(int aIndex)
      Returns the attribute type at the given index.
      Parameters:
      aIndex - the index of the attribute type to be returned.
      Returns:
      the attribute type at the given index.
      Throws:
      IndexOutOfBoundsException - if aIndex < 0 || aIndex >= getAtttributeTypeCount().

    • getAttributeTypeForCode

      public TLcdGDFAttributeType getAttributeTypeForCode(String aAttributeTypeCode)
      Returns the attribute type with the given attribute type code.
      Parameters:
      aAttributeTypeCode - the attribute type code of the attribute to be returned.
      Returns:
      the attribute type with the given attribute type code.
      Throws:
      IllegalArgumentException - if no attribute type is available for the given attribute type code.

    • getFeatureClassCount

      public int getFeatureClassCount()
      Returns the number of feature classes involved in the dataset.
      Returns:
      the number of feature classes involved in the dataset.

    • getFeatureClass

      public TLcdGDFFeatureClass getFeatureClass(int aIndex)
      Returns the feature class at the given index.
      Parameters:
      aIndex - the index of the feature class to be returned.
      Returns:
      the feature class at the given index.
      Throws:
      IndexOutOfBoundsException - if aIndex < 0 || aIndex >= getFeatureClassCount().

    • getFeatureClassForCode

      public TLcdGDFFeatureClass getFeatureClassForCode(int aFeatureClassCode)
      Returns the feature class with the given feature class code.
      Parameters:
      aFeatureClassCode - the feature class code of the feature class to be returned.
      Returns:
      the feature class with the given feature type code.
      Throws:
      IllegalArgumentException - if no feature class is available for the given feature class code.

    • getRelationshipTypeCount

      public int getRelationshipTypeCount()
      Returns the number of relationship types involved in the dataset.
      Returns:
      the number of relationship types involved in the dataset.

    • getRelationship

      public TLcdGDFRelationshipType getRelationship(int aIndex)
      Returns the relationship type at the given index.
      Parameters:
      aIndex - the index of the relationship type to be returned.
      Returns:
      the relationship type at the given index.
      Throws:
      IndexOutOfBoundsException - if aIndex < 0 || aIndex >= getRElationshipTypeCount().

    • getRelationshipTypeForCode

      public TLcdGDFRelationshipType getRelationshipTypeForCode(int aRelationshipTypeCode)
      Returns the relationship type with the given relationship type code.
      Parameters:
      aRelationshipTypeCode - the relationship type code of the relationship type to be returned.
      Returns:
      the relationship type with the given relationship type code.
      Throws:
      IllegalArgumentException - if no relationship type is available for the given relationship type code.

    • 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

    • 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

    • 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