com.sibvisions.rad.persist.jdbc
Class ServerMetaData

java.lang.Object
  com.sibvisions.rad.persist.jdbc.ServerMetaData

All Implemented Interfaces:

Cloneable

public class ServerMetaData
extends Object
implements Cloneable

The ServerMetaData is a description of all columns as ServerColumnMetaData, the Primary Key columns, Representation columns and auto increment columns. It also includes the server relevant infos, in addition to the MetaData just for the client.

See Also:

ServerColumnMetaData

Nested Class Summary

static class

ServerMetaData.PrimaryKeyType the possible types for the pk columns.

Constructor Summary

ServerMetaData()
Creates a new instance of ServerMetaData with new MetaData.

Method Summary

void	addServerColumnMetaData(ServerColumnMetaData pServerColumnMetaData) Adds an new ServerColumnMetaData column.
ServerMetaData	clone()
int[]	getAutoIncrementColumnIndices() Returns the auto increment column name indices.
String[]	getAutoIncrementColumnNames() Returns the auto increment column names.
String[]	getAutoIncrementQuotedColumnNames() Returns the quoted auto increment column names.
String[]	getColumnNames() Returns all column names of the ColumnMetaData list.
String	getFromClause() Gets the from clause.
MetaData	getMetaData() Returns the MetaData client infos.
int[]	getPrimaryKeyColumnIndices() Returns the Primary Key column name indices.
String[]	getPrimaryKeyColumnNames() Returns the Primary Key column names.
String[]	getPrimaryKeyQuotedColumnNames() Returns the Primary Key column names.
ServerMetaData.PrimaryKeyType	getPrimaryKeyType() Gets the type of the Primary key columns.
String[]	getQueryColumns() Gets the query columns.
String[]	getRepresentationColumnNames() Returns the Representation column names.
String[]	getRepresentationQuotedColumnNames() Returns the quoted Representation column names.
ServerColumnMetaData[]	getServerColumnMetaData() Returns all ServerColumnMetaData columns.
ServerColumnMetaData	getServerColumnMetaData(String pServerColumnName) Returns the specific ServerColumnMetaData column.
int	getServerColumnMetaDataIndex(String pServerColumnName) Returns the specific ServerColumnMetaData column index. -1 if the Column name doesn't exist.
int[]	getWritableColumnIndices() Returns all writable column name indices.
void	setAutoIncrementColumnNames(Name[] pAutoIncrementColumnNames) Sets the auto increment column names.
void	setFromClause(String pFrom) Sets the from clause.
void	setPrimaryKeyColumnNames(Name[] pPrimaryKeyColumnNames) Sets the Primary Key column names.
void	setPrimaryKeyType(ServerMetaData.PrimaryKeyType pType) Gets the type of the Primary key columns.
void	setQueryColumns(String[] pColumns) Sets the query columns.
void	setRepresentationColumnNames(Name[] pRepresentationColumnNames) Sets the Representation column names.
void	setServerColumnMetaData(ServerColumnMetaData[] pServerColumnMetaData) Sets all ServerMetaData columns.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerMetaData

public ServerMetaData()

Creates a new instance of ServerMetaData with new MetaData.

Method Detail

clone

public ServerMetaData clone()

Overrides:

clone in class Object

getMetaData

public MetaData getMetaData()

Returns the MetaData client infos.

Returns:

the MetaData client infos.

addServerColumnMetaData

public void addServerColumnMetaData(ServerColumnMetaData pServerColumnMetaData)

Adds an new ServerColumnMetaData column.

Parameters:

pServerColumnMetaData - the column meta data to add

setServerColumnMetaData

public void setServerColumnMetaData(ServerColumnMetaData[] pServerColumnMetaData)

Sets all ServerMetaData columns.

Parameters:

pServerColumnMetaData - the column meta data to add

getServerColumnMetaData

public ServerColumnMetaData[] getServerColumnMetaData()

Returns all ServerColumnMetaData columns.

Returns:

all ServerColumnMetaData columns.

getServerColumnMetaData

public ServerColumnMetaData getServerColumnMetaData(String pServerColumnName)
                                             throws ModelException

Returns the specific ServerColumnMetaData column.

Parameters:

pServerColumnName - the column name to use.

Returns:

the specific ServerColumnMetaData column.

Throws:

ModelException - if the column name doesn't exists

getServerColumnMetaDataIndex

public int getServerColumnMetaDataIndex(String pServerColumnName)

Returns the specific ServerColumnMetaData column index. -1 if the Column name doesn't exist.

Parameters:

pServerColumnName - the column name to use.

Returns:

the specific ServerColumnMetaData column index.

getWritableColumnIndices

public int[] getWritableColumnIndices()

Returns all writable column name indices.

Returns:

all writable column name indices.

getPrimaryKeyColumnIndices

public int[] getPrimaryKeyColumnIndices()

Returns the Primary Key column name indices.

Returns:

the Primary Key column name indices.

getAutoIncrementColumnIndices

public int[] getAutoIncrementColumnIndices()

Returns the auto increment column name indices.

Returns:

the auto increment column name indices.

getPrimaryKeyColumnNames

public String[] getPrimaryKeyColumnNames()

Returns the Primary Key column names.

Returns:

the Primary Key column names.

getPrimaryKeyQuotedColumnNames

public String[] getPrimaryKeyQuotedColumnNames()

Returns the Primary Key column names.

Returns:

the Primary Key column names.

setPrimaryKeyColumnNames

public void setPrimaryKeyColumnNames(Name[] pPrimaryKeyColumnNames)

Sets the Primary Key column names.

Parameters:

pPrimaryKeyColumnNames - the Primary Key column names to set

getRepresentationColumnNames

public String[] getRepresentationColumnNames()

Returns the Representation column names. Thats all Unique Key columns as default behavior.

Returns:

the Representation column names.

getRepresentationQuotedColumnNames

public String[] getRepresentationQuotedColumnNames()

Returns the quoted Representation column names.

Returns:

the quoted Representation column names.

setRepresentationColumnNames

public void setRepresentationColumnNames(Name[] pRepresentationColumnNames)

Sets the Representation column names.

Parameters:

pRepresentationColumnNames - the Representation column names to set

getAutoIncrementColumnNames

public String[] getAutoIncrementColumnNames()

Returns the auto increment column names.

Returns:

the auto increment column names.

getAutoIncrementQuotedColumnNames

public String[] getAutoIncrementQuotedColumnNames()

Returns the quoted auto increment column names.

Returns:

the quoted auto increment column names.

setAutoIncrementColumnNames

public void setAutoIncrementColumnNames(Name[] pAutoIncrementColumnNames)

Sets the auto increment column names.

Parameters:

pAutoIncrementColumnNames - the auto increment column names. to set

getColumnNames

public String[] getColumnNames()

Returns all column names of the ColumnMetaData list.

Returns:

all column names of the ColumnMetaData list.

setFromClause

public void setFromClause(String pFrom)

Sets the from clause.

Parameters:

pFrom - the from clause

getFromClause

public String getFromClause()

Gets the from clause.

Returns:

the from clause

setQueryColumns

public void setQueryColumns(String[] pColumns)

Sets the query columns.

Parameters:

pColumns - the query columns

getQueryColumns

public String[] getQueryColumns()

Gets the query columns.

Returns:

the query columns

getPrimaryKeyType

public ServerMetaData.PrimaryKeyType getPrimaryKeyType()

Gets the type of the Primary key columns.

Returns:

the pk type

See Also:

ServerMetaData.PrimaryKeyType

setPrimaryKeyType

public void setPrimaryKeyType(ServerMetaData.PrimaryKeyType pType)

Gets the type of the Primary key columns.

Parameters:

pType - the type