public class TLcdHanaModelDescriptor extends Object implements ILcdDataModelDescriptor
Model descriptor for hana models.
WARNING: beta. This class may be modified or removed in subsequent releases.
Modifier and Type | Method and Description |
---|---|
static TLcdHanaModelDescriptor |
createModelDescriptor(String aUrl,
String aTableName,
String[] aColumnNames,
String[] aColumnClassNames,
String aGeometryColumnName)
Creates a new hana model descriptor using the given parameters.
|
TLcdDataModel |
getDataModel()
Returns the data model that describes the elements of the model.
|
String |
getDisplayName()
Returns a displayable name for the data source, suitable for usage in user interfaces.
|
String |
getGeometryColumn()
Returns the name of the column in which the geometry is stored.
|
TLcdDataType |
getModelElementType()
Returns the data type of the model elements.
|
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.
|
String |
getSourceName()
Returns the full name that uniquely identifies the data source.
|
String |
getTableName()
Returns the name of the database table.
|
String |
getTypeName()
Returns the type/format name of the data source.
|
String |
getURL()
Returns the JDBC connection URL.
|
public static TLcdHanaModelDescriptor createModelDescriptor(String aUrl, String aTableName, String[] aColumnNames, String[] aColumnClassNames, String aGeometryColumnName)
aUrl
- the JDBC connection URL.aTableName
- the database table name.aColumnNames
- the column names of the data properties that should be retrieved.aColumnClassNames
- the class names that represent the type of the values in the columns that should be retrievedaGeometryColumnName
- the column name where the geometry is storedpublic String getURL()
public String getTableName()
public TLcdDataType getModelElementType()
public String getGeometryColumn()
public TLcdDataModel getDataModel()
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)
).
getDataModel
in interface ILcdDataModelDescriptor
public Set<TLcdDataType> getModelElementTypes()
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() )
.
getModelElementTypes
in interface ILcdDataModelDescriptor
public Set<TLcdDataType> getModelTypes()
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.
getModelTypes
in interface ILcdDataModelDescriptor
public String getTypeName()
ILcdModelDescriptor
getTypeName
in interface ILcdModelDescriptor
public String getDisplayName()
ILcdModelDescriptor
getDisplayName
in interface ILcdModelDescriptor
public String getSourceName()
ILcdModelDescriptor
getSourceName
in interface ILcdModelDescriptor