com.luciad.format.svg

LuciadFusionClass TLcdSVGModelDescriptor

java.lang.Object

com.luciad.model.TLcdModelDescriptor

com.luciad.format.svg.TLcdSVGModelDescriptor

All Implemented Interfaces:

ILcdSVGModelDescriptor, ILcdDataModelDescriptor, ILcdModelDescriptor, Serializable

public class TLcdSVGModelDescriptor
extends TLcdModelDescriptor
implements ILcdSVGModelDescriptor

A tag descriptor to identify models containing SVG data. This implementation does not offer extra functionality with regard to its superclass.

This ILcdDataModelDescriptor declares all model element data types that can be represented by an SVG model are non-primitive. This means that they implement ILcdDataObject. The default shape factories TLcdSVGUnStyledLonLatShapeFactory and TLcdSVGUnStyledXYShapeFactory make sure that all its shapes implement ILcdDataObject. Custom shape factories will either have to:

• Make sure their shapes implement ILcdDataObject as well.
• Create a custom TLcdDataModel for the ILcdSVGModelDescriptor that has all of its TLcdDataTypes set as primitive.

The default data model used by this model descriptor can be found in TLcdSVGDataTypes.getDataModel().

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TLcdSVGModelDescriptor() Deprecated. use the constructor with 2 parameters instead.
TLcdSVGModelDescriptor(String aSourceName, String aDisplayName) Constructs a new TLcdSVGModelDescriptor with the given source and display name.
TLcdSVGModelDescriptor(String aSourceName, String aTypeName, String aDisplayName) Deprecated. use the constructor with 2 parameters instead.

Method Summary

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.

Methods inherited from class com.luciad.model.TLcdModelDescriptor

getDisplayName, getSourceName, getTypeName, setDisplayName, setSourceName, setTypeName, sourceNameToDisplayName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.luciad.model.ILcdModelDescriptor

getDisplayName, getSourceName, getTypeName

Constructor Detail

TLcdSVGModelDescriptor

public TLcdSVGModelDescriptor()

Deprecated. use the constructor with 2 parameters instead.

Constructs a new TLcdSVGModelDescriptor with a default source name, default type name, and default display name.

TLcdSVGModelDescriptor

public TLcdSVGModelDescriptor(String aSourceName,
                              String aTypeName,
                              String aDisplayName)

Deprecated. use the constructor with 2 parameters instead.

Constructs a new TLcdSVGModelDescriptor with the given source name, type name, and display name.

Parameters:

aSourceName - identifies the source of the data contained in the model.

aTypeName - a type name for the data.

aDisplayName - the display name of the model.

TLcdSVGModelDescriptor

public TLcdSVGModelDescriptor(String aSourceName,
                              String aDisplayName)

Constructs a new TLcdSVGModelDescriptor with the given source and display name. The type name is set equal to ILcdSVGConstants.MODELTYPE.

Parameters:

aSourceName - identifies the source of the data contained in the model.

aDisplayName - the display name of the model.

Method Detail

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