Package com.luciad.format.vpf

Class TLcdVPFModelDescriptor

java.lang.Object

com.luciad.model.TLcdModelDescriptor

com.luciad.format.vpf.TLcdVPFModelDescriptor

All Implemented Interfaces:

ILcdDataModelDescriptor, ILcdModelDescriptor, ILcdFeaturedDescriptor, Serializable

public class TLcdVPFModelDescriptor
extends TLcdModelDescriptor
implements ILcdDataModelDescriptor, ILcdFeaturedDescriptor

Model descriptor used for VPF models.

This model descriptor provides some extra information about the VPF model:

• The model type (see TLcdVPFModelDecoder.ModelType for more information on VPF model types).
• The VPF feature class.
• The type of feature (POINT, LINE, AREA, TEXT or COMPLEX).
• Descriptions of the ILcdFeatured attributes, via the ILcdFeaturedDescriptor interface.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AREA	Constant to indicate that the described model contains only VPF area features.
static final int	COMPLEX	Constant to indicate that the described model contains only VPF complex features.
static final int	EMPTY_MODEL	Deprecated. replaced by ON_THE_FLY_MODEL_TYPE
static final int	FULL_MODEL	Deprecated. replaced by IN_MEMORY_MODEL_TYPE
protected int	fVPFFeatureType	Deprecated. Don't access this variable directly.
static final int	HYBRID_MODEL_TYPE	Constant to indicate that the model is a hybrid model, each feature being loaded dynamically when it is needed, with caching enabled.
static final int	IN_MEMORY_MODEL_TYPE	Constant to indicate that the model is an in-memory model, with all features loaded in memory.
static final int	LINE	Constant to indicate that the described model contains only VPF line features.
static final int	MULTIPLE_TYPE	Constant to indicate that the described model contains VPF features of multiple types.
static final int	ON_THE_FLY_MODEL_TYPE	Constant to indicate that the model is an on-the-fly model, each feature being loaded dynamically when it is needed.
static final int	POINT	Constant to indicate that the described model contains only VPF point features.
static final int	TEXT	Constant to indicate that the described model contains only VPF text features.
static final String	TYPE_NAME	Type name identifying the VPF format type.

Constructor Summary

Constructors

Constructor	Description
TLcdVPFModelDescriptor()	Constructs a new, empty TLcdVPFModelDescriptor.
TLcdVPFModelDescriptor(String aSourceName, String aDisplayName)	Constructs a new TLcdVPFModelDescriptor.
TLcdVPFModelDescriptor(String aSourceName, String aTypeName, String aDisplayName, TLcdVPFFeatureClass aVPFFeatureClass)	Constructs a new TLcdVPFModelDescriptor.
TLcdVPFModelDescriptor(String aSourceName, String aTypeName, String aDisplayName, TLcdVPFFeatureClass aVPFFeatureClass, int aModelType)	Constructs a new TLcdVPFModelDescriptor.

Method Summary

Modifier and Type	Method	Description
ILcdBounds	getBounds()	Deprecated. All VPF models implement the ILcd2DBoundsIndexedModel interface.
TLcdDataModel	getDataModel()	Returns the data model that describes the elements of the model.
Class	getFeatureClass(int aIndex)	Returns the Class of the feature at the given index.
int	getFeatureCount()	Returns the number of features.
int	getFeatureIndex(String aName)	Returns the index of the given feature name if it exists, -1 otherwise.
String	getFeatureName(int aIndex)	Returns the name of the feature at the given index.
Set<TLcdDataType>	getModelElementTypes()	Returns a set containing all the data types of which instances can be elements in the model associated with this descriptor.
int	getModelType()	Returns the model type of this model (IN_MEMORY_MODEL_TYPE or ON_THE_FLY_MODEL_TYPE).
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.
TLcdVPFFeatureClass	getVPFFeatureClass()	Returns the VPF feature class of the features contained in this model descriptor's model.
int	getVPFFeatureType()	Returns the type of the VPF feature contained in this model.
void	setDefaultFeatureCount(int aDefaultFeatureCount)	Sets the default feature count that should be returned if no feature class is associated with this model (default value is zero).

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

getFeatureUnitOfMeasure

Methods inherited from interface com.luciad.model.ILcdModelDescriptor

getDisplayName, getSourceName, getTypeName

Field Details

TYPE_NAME

public static final String TYPE_NAME

Type name identifying the VPF format type.

See Also:

• Constant Field Values

POINT

public static final int POINT

Constant to indicate that the described model contains only VPF point features.

See Also:

• Constant Field Values

LINE

public static final int LINE

Constant to indicate that the described model contains only VPF line features.

See Also:

• Constant Field Values

AREA

public static final int AREA

Constant to indicate that the described model contains only VPF area features.

See Also:

• Constant Field Values

TEXT

public static final int TEXT

Constant to indicate that the described model contains only VPF text features.

See Also:

• Constant Field Values

COMPLEX

public static final int COMPLEX

Constant to indicate that the described model contains only VPF complex features.

See Also:

• Constant Field Values

MULTIPLE_TYPE

public static final int MULTIPLE_TYPE

Constant to indicate that the described model contains VPF features of multiple types.

See Also:

• Constant Field Values

FULL_MODEL

public static final int FULL_MODEL

Deprecated.

replaced by IN_MEMORY_MODEL_TYPE

Constant to indicate that the described model contains an element for every vpf feature the user wants to handle.

See Also:

• Constant Field Values

EMPTY_MODEL

public static final int EMPTY_MODEL

Deprecated.

replaced by ON_THE_FLY_MODEL_TYPE

Constant to indicate that the described model contains elements that don't relate one to one to the vpf features the user wants to handle.

See Also:

• Constant Field Values

IN_MEMORY_MODEL_TYPE

public static final int IN_MEMORY_MODEL_TYPE

Constant to indicate that the model is an in-memory model, with all features loaded in memory.

See Also:

• for more information about model types.
• Constant Field Values

ON_THE_FLY_MODEL_TYPE

public static final int ON_THE_FLY_MODEL_TYPE

Constant to indicate that the model is an on-the-fly model, each feature being loaded dynamically when it is needed.

See Also:

• for more information about model types.
• Constant Field Values

HYBRID_MODEL_TYPE

public static final int HYBRID_MODEL_TYPE

Constant to indicate that the model is a hybrid model, each feature being loaded dynamically when it is needed, with caching enabled.

See Also:

• for more information about model types.
• Constant Field Values

fVPFFeatureType

protected int fVPFFeatureType

Deprecated.

Don't access this variable directly. Use getFeatureType() instead.

VPF feature type.

Constructor Details

TLcdVPFModelDescriptor

public TLcdVPFModelDescriptor()

Constructs a new, empty TLcdVPFModelDescriptor.

TLcdVPFModelDescriptor

public TLcdVPFModelDescriptor(String aSourceName,
 String aDisplayName)

Constructs a new TLcdVPFModelDescriptor.

Parameters:

aSourceName - the name of the data source.

aDisplayName - the display name of the data source.

TLcdVPFModelDescriptor

public TLcdVPFModelDescriptor(String aSourceName,
 String aTypeName,
 String aDisplayName,
 TLcdVPFFeatureClass aVPFFeatureClass)

Constructs a new TLcdVPFModelDescriptor.

Parameters:

aSourceName - the name of the data source.

aTypeName - the type name of the data source.

aDisplayName - the display name of the data source.

aVPFFeatureClass - the VPF feature class of the model.

TLcdVPFModelDescriptor

public TLcdVPFModelDescriptor(String aSourceName,
 String aTypeName,
 String aDisplayName,
 TLcdVPFFeatureClass aVPFFeatureClass,
 int aModelType)

Constructs a new TLcdVPFModelDescriptor.

Parameters:

aSourceName - the name of the data source.

aTypeName - the type name of the data source.

aDisplayName - the display name of the data source.

aVPFFeatureClass - the VPF feature class of the model.

aModelType - the model type of the model. See TLcdVPFModelDecoder.ModelType for more information on VPF model types.

Method Details

getModelType

public int getModelType()

Returns the model type of this model (IN_MEMORY_MODEL_TYPE or ON_THE_FLY_MODEL_TYPE).

Returns:

the model type of this model.

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

getFeatureClass

public Class getFeatureClass(int aIndex)

Description copied from interface: ILcdFeaturedDescriptor

Returns the Class of the feature at the given index.

Specified by:

getFeatureClass in interface ILcdFeaturedDescriptor

Parameters:

aIndex - a valid feature index.

Returns:

the Class of the feature at the given index.

getFeatureCount

public int getFeatureCount()

Description copied from interface: ILcdFeaturedDescriptor

Returns the number of features.

Specified by:

getFeatureCount in interface ILcdFeaturedDescriptor

Returns:

the number of features.

getFeatureIndex

public int getFeatureIndex(String aName)

Description copied from interface: ILcdFeaturedDescriptor

Returns the index of the given feature name if it exists, -1 otherwise.

Specified by:

getFeatureIndex in interface ILcdFeaturedDescriptor

Parameters:

aName - a feature name.

Returns:

the index of the given feature name if it exists, -1 otherwise.

getFeatureName

public String getFeatureName(int aIndex)

Description copied from interface: ILcdFeaturedDescriptor

Returns the name of the feature at the given index.

Specified by:

getFeatureName in interface ILcdFeaturedDescriptor

Parameters:

aIndex - a valid feature index.

Returns:

the name of the feature at the given index.

getVPFFeatureType

public int getVPFFeatureType()

Returns the type of the VPF feature contained in this model. This is either POINT, LINE, AREA, TEXT, COMPLEX or MULTIPLE TYPE.

Returns:

the type of the VPF feature contained in this model.

getVPFFeatureClass

public TLcdVPFFeatureClass getVPFFeatureClass()

Returns the VPF feature class of the features contained in this model descriptor's model.

Returns:

the VPF feature class of the features contained in this model descriptor's model.

getBounds

public ILcdBounds getBounds()

Deprecated.

All VPF models implement the ILcd2DBoundsIndexedModel interface. use the moddel.getBounds() method to retrieve the model's bounds.

Returns the bounds of this model descriptor's model, in model coordinates.

Returns:

the bounds of this model descriptor's model, in model coordinates.

setDefaultFeatureCount

public void setDefaultFeatureCount(int aDefaultFeatureCount)

Sets the default feature count that should be returned if no feature class is associated with this model (default value is zero).

Parameters:

aDefaultFeatureCount - the default feature count to be used.