Package com.luciad.format.sqlite.lvdb

Class TLcdLVDBModelDescriptor

java.lang.Object

com.luciad.model.TLcdModelDescriptor

com.luciad.format.sqlite.lvdb.TLcdLVDBModelDescriptor

All Implemented Interfaces:

ILcdDatabaseModelDescriptor, ILcdDataModelDescriptor, ILcdModelDescriptor, ILcdFeaturedDescriptor, Serializable, Cloneable

public class TLcdLVDBModelDescriptor
extends TLcdModelDescriptor
implements ILcdDatabaseModelDescriptor

Model descriptor for Luciad Vector Databases (LVDB).

Since:

2013.1

See Also:

• TLcdLVDBModelDecoder
• Serialized Form

Method Summary

Modifier and Type	Method	Description
Object	clone()
void	close()	Closes the Connection of this descriptor, if it was opened.
ILcdBounds	getBounds()	returns the bounds of the geometry.
String	getColumnNames()	Concatenates the main column name and the feature column names into a single String of comma-separated column names.
String	getColumnNamesAndTypes()	Concatenates the main column name and type, and the feature column names and types into a single String of comma-separated column names and types.
TLcdDataModel	getDataModel()	Returns the data model that describes the elements of the model.
ILcdEllipsoid	getEllipsoid()	Returns the ellipsoid of the database object reference.
Class	getFeatureClass(int i)	Returns the Class of the feature at the given index.
int	getFeatureCount()	Returns the number of features.
int	getFeatureIndex(String s)	Returns the index of the given feature name if it exists, -1 otherwise.
String	getFeatureName(int i)	Returns the name of a particular feature.
String	getFeatureType(int i)	Returns the type of a given feature.
String	getGeometryColumnName()	Returns the name of the table column containing the geometry.
String	getGeometryType()	Returns the type of the geometry.
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.
int	getPrimaryFeatureIndex()	Returns the primary feature index.
String	getSelectionFilter()	Returns the string representing the selection filter.
String	getSelectionTables()	Returns the names of the additional tables used in the select query
int	getSRID()	Returns the Spatial Reference ID number.
String	getTableName()	Returns the name of the database table.
void	setBounds(ILcdBounds aBounds)	Sets the bounds of the geometry.
void	setEllipsoid(ILcdEllipsoid aEllipsoid)	Sets the ellipsoid of the database object's reference.
void	setFeatureNames(String[] aStrings)	Sets the names of the features to be selected.
void	setFeatureTypes(String[] aStrings)	Sets the types of the features.
void	setGeometryColumnName(String aGeometryColumnName)	Sets the name of the column containing the database geometry object.
void	setGeometryType(String aGeometryType)	Sets the type of the geometry.
void	setPrimaryFeatureIndex(int i)	Sets the primary feature index
void	setSelectionFilter(String aSelectionFilter)	A selection filter string , normally appended to the WHERE part of the select query.
void	setSelectionTables(String aSelectionTables)	Sets the names of additional tables used in the select query.
void	setSRID(int aSRID)	Sets the Spatial Reference ID number.
void	setTableName(String aTableName)	Sets the name of the database table.

Methods inherited from class com.luciad.model.TLcdModelDescriptor

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

Methods inherited from class java.lang.Object

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

Method Details

setTableName

public void setTableName(String aTableName)

Description copied from interface: ILcdDatabaseModelDescriptor

Sets the name of the database table.

Specified by:

setTableName in interface ILcdDatabaseModelDescriptor

Parameters:

aTableName - the name of the database table.

getTableName

public String getTableName()

Description copied from interface: ILcdDatabaseModelDescriptor

Returns the name of the database table.

Specified by:

getTableName in interface ILcdDatabaseModelDescriptor

Returns:

a table name.

setSelectionTables

public void setSelectionTables(String aSelectionTables)

Description copied from interface: ILcdDatabaseModelDescriptor

Sets the names of additional tables used in the select query.

Specified by:

setSelectionTables in interface ILcdDatabaseModelDescriptor

Parameters:

aSelectionTables - a list of additional tables separated by columns.

getSelectionTables

public String getSelectionTables()

Description copied from interface: ILcdDatabaseModelDescriptor

Returns the names of the additional tables used in the select query

Specified by:

getSelectionTables in interface ILcdDatabaseModelDescriptor

Returns:

a list of additional tables, separated by columns.

setSelectionFilter

public void setSelectionFilter(String aSelectionFilter)

Description copied from interface: ILcdDatabaseModelDescriptor

A selection filter string , normally appended to the WHERE part of the select query.

Specified by:

setSelectionFilter in interface ILcdDatabaseModelDescriptor

Parameters:

aSelectionFilter - a selection filter string.

getSelectionFilter

public String getSelectionFilter()

Description copied from interface: ILcdDatabaseModelDescriptor

Returns the string representing the selection filter.

Specified by:

getSelectionFilter in interface ILcdDatabaseModelDescriptor

Returns:

the selection filter.

setGeometryColumnName

public void setGeometryColumnName(String aGeometryColumnName)

Description copied from interface: ILcdDatabaseModelDescriptor

Sets the name of the column containing the database geometry object.

Specified by:

setGeometryColumnName in interface ILcdDatabaseModelDescriptor

Parameters:

aGeometryColumnName - the name of the table column containing the geometry.

getGeometryColumnName

public String getGeometryColumnName()

Description copied from interface: ILcdDatabaseModelDescriptor

Returns the name of the table column containing the geometry.

Specified by:

getGeometryColumnName in interface ILcdDatabaseModelDescriptor

Returns:

the name of the column containing the geometry.

setFeatureNames

public void setFeatureNames(String[] aStrings)

Description copied from interface: ILcdDatabaseModelDescriptor

Sets the names of the features to be selected.

Specified by:

setFeatureNames in interface ILcdDatabaseModelDescriptor

Parameters:

aStrings - a list of feature names.

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.

getFeatureName

public String getFeatureName(int i)

Description copied from interface: ILcdDatabaseModelDescriptor

Returns the name of a particular feature.

Specified by:

getFeatureName in interface ILcdDatabaseModelDescriptor

Specified by:

getFeatureName in interface ILcdFeaturedDescriptor

Parameters:

i - the feature index.

Returns:

the name corresponding to the given index.

getFeatureIndex

public int getFeatureIndex(String s)

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:

s - a feature name.

Returns:

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

getFeatureClass

public Class getFeatureClass(int i)

Description copied from interface: ILcdFeaturedDescriptor

Returns the Class of the feature at the given index.

Specified by:

getFeatureClass in interface ILcdFeaturedDescriptor

Parameters:

i - a valid feature index.

Returns:

the Class of the feature at the given index.

setPrimaryFeatureIndex

public void setPrimaryFeatureIndex(int i)

Description copied from interface: ILcdDatabaseModelDescriptor

Sets the primary feature index

Specified by:

setPrimaryFeatureIndex in interface ILcdDatabaseModelDescriptor

Parameters:

i - the primary feature index

getPrimaryFeatureIndex

public int getPrimaryFeatureIndex()

Description copied from interface: ILcdDatabaseModelDescriptor

Returns the primary feature index.

Specified by:

getPrimaryFeatureIndex in interface ILcdDatabaseModelDescriptor

Returns:

the primary feature index.

setSRID

public void setSRID(int aSRID)

Description copied from interface: ILcdDatabaseModelDescriptor

Sets the Spatial Reference ID number.

Specified by:

setSRID in interface ILcdDatabaseModelDescriptor

Parameters:

aSRID - a spatial reference ID.

getSRID

public int getSRID()

Description copied from interface: ILcdDatabaseModelDescriptor

Returns the Spatial Reference ID number.

Specified by:

getSRID in interface ILcdDatabaseModelDescriptor

Returns:

the Spatial reference ID number.

setEllipsoid

public void setEllipsoid(ILcdEllipsoid aEllipsoid)

Description copied from interface: ILcdDatabaseModelDescriptor

Sets the ellipsoid of the database object's reference.

Specified by:

setEllipsoid in interface ILcdDatabaseModelDescriptor

Parameters:

aEllipsoid - the ellipsoid of the database object's reference.

getEllipsoid

public ILcdEllipsoid getEllipsoid()

Description copied from interface: ILcdDatabaseModelDescriptor

Returns the ellipsoid of the database object reference.

Specified by:

getEllipsoid in interface ILcdDatabaseModelDescriptor

Returns:

an ellipsoid

setBounds

public void setBounds(ILcdBounds aBounds)

Description copied from interface: ILcdDatabaseModelDescriptor

Sets the bounds of the geometry.

Specified by:

setBounds in interface ILcdDatabaseModelDescriptor

Parameters:

aBounds - the bounds of the geometry.

getBounds

public ILcdBounds getBounds()

Description copied from interface: ILcdDatabaseModelDescriptor

returns the bounds of the geometry.

Specified by:

getBounds in interface ILcdDatabaseModelDescriptor

Returns:

the bounds of the geometry.

setGeometryType

public void setGeometryType(String aGeometryType)

Description copied from interface: ILcdDatabaseModelDescriptor

Sets the type of the geometry.

Specified by:

setGeometryType in interface ILcdDatabaseModelDescriptor

Parameters:

aGeometryType - type of the geometry.

getGeometryType

public String getGeometryType()

Description copied from interface: ILcdDatabaseModelDescriptor

Returns the type of the geometry.

Specified by:

getGeometryType in interface ILcdDatabaseModelDescriptor

Returns:

type of the geometry.

setFeatureTypes

public void setFeatureTypes(String[] aStrings)

Description copied from interface: ILcdDatabaseModelDescriptor

Sets the types of the features.

Specified by:

setFeatureTypes in interface ILcdDatabaseModelDescriptor

Parameters:

aStrings - the types of the features.

getFeatureType

public String getFeatureType(int i)

Description copied from interface: ILcdDatabaseModelDescriptor

Returns the type of a given feature.

Specified by:

getFeatureType in interface ILcdDatabaseModelDescriptor

Parameters:

i - the feature index.

Returns:

the feature type.

getColumnNames

public String getColumnNames()

Description copied from interface: ILcdDatabaseModelDescriptor

Concatenates the main column name and the feature column names into a single String of comma-separated column names.

Specified by:

getColumnNames in interface ILcdDatabaseModelDescriptor

Returns:

a String containing the comma-separated column names.

getColumnNamesAndTypes

public String getColumnNamesAndTypes()

Description copied from interface: ILcdDatabaseModelDescriptor

Concatenates the main column name and type, and the feature column names and types into a single String of comma-separated column names and types.

Specified by:

getColumnNamesAndTypes in interface ILcdDatabaseModelDescriptor

Returns:

a String containing the main column name and type, and the feature column names and types, separated by commas.

close

public void close()

Description copied from interface: ILcdDatabaseModelDescriptor

Closes the Connection of this descriptor, if it was opened.

Specified by:

close in interface ILcdDatabaseModelDescriptor

clone

public Object clone()

Specified by:

clone in interface ILcdDatabaseModelDescriptor

Overrides:

clone in class Object

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