public class TLcdCGMModelDescriptor extends TLcdModelDescriptor implements ILcdDataModelDescriptor
This model descriptor is used to identify CGM models
.The CGM model descriptor implements ILcdDataModelDescriptor. The data types
for this model can be found in the TLcdCGMDataTypes class. Each CGM model can include
model elements of more than a single type. For this reason, the model elements can be set at
construction. Usually, the
model decoder will take care of identifying the types inside a model. If the model is updated
to feature more model element data types, a new model descriptor will have to be added with
an updated list of model element data types.
| Constructor and Description |
|---|
TLcdCGMModelDescriptor(String aSourceName,
String aDisplayName,
String aTypeName)
Creates a
TLcdCGMModelDescriptor without any known model element
data types. |
TLcdCGMModelDescriptor(String aSourceName,
String aDisplayName,
String aTypeName,
Set<TLcdDataType> aModelElementTypes)
Creates a
TLcdCGMModelDescriptor with a list of known model element
data types. |
| Modifier and Type | Method and Description |
|---|---|
TLcdDataModel |
getDataModel()
Returns the data model that describes the elements of the model.
|
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 TLcdCGMModelDescriptor(String aSourceName, String aDisplayName, String aTypeName)
TLcdCGMModelDescriptor without any known model element
data types. Using this constructor, a call to getModelElementTypes() will
return TLcdCGMDataTypes.AbstractCGMType. The data model of this model descriptor
is the one defined in TLcdCGMDataTypes.aSourceName - A source name of the CGM fileaDisplayName - The display name of the modelaTypeName - The type name of the modelpublic TLcdCGMModelDescriptor(String aSourceName, String aDisplayName, String aTypeName, Set<TLcdDataType> aModelElementTypes)
TLcdCGMModelDescriptor with a list of known model element
data types. A call to getModelElementTypes() will return the given set
of data types. The data model of this model descriptor is the one defined
in TLcdCGMDataTypes.aSourceName - A source name of the CGM fileaDisplayName - The display name of the modelaTypeName - The type name of the modelaModelElementTypes - A list of model element data types used by this model. This is a list
of any of the data types found in the TLcdCGMDataTypes class.public 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 ILcdDataModelDescriptor