com.sibvisions.rad.persist.jdbc
Class ServerMetaData

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

All Implemented Interfaces:

java.lang.Cloneable

public class ServerMetaData
extends java.lang.Object
implements java.lang.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.
int[]	getAutoIncrementColumnIndices() Returns the auto increment column name indices.
java.lang.String[]	getAutoIncrementColumnNames() Returns the auto increment column names.
java.lang.String[]	getColumnNames() Returns all column names of the ColumnMetaData list.
MetaData	getMetaData() Returns the MetaData client infos.
int[]	getPrimaryKeyColumnIndices() Returns the Primary Key column name indices.
java.lang.String[]	getPrimaryKeyColumnNames() Returns the Primary Key column names.
ServerMetaData.PrimaryKeyType	getPrimaryKeyType() Gets the type of the Primary key columns.
java.lang.String[]	getRepresentationColumnNames() Returns the Representation column names.
ServerColumnMetaData[]	getServerColumnMetaData() Returns all ServerColumnMetaData columns.
ServerColumnMetaData	getServerColumnMetaData(int pIndex) Returns the specific ServerColumnMetaData column index. -1 if the Column name doesn't exist.
ServerColumnMetaData	getServerColumnMetaData(java.lang.String pServerColumnName) Returns the specific ServerColumnMetaData column.
static int	getServerColumnMetaDataIndex(ServerColumnMetaData[] pServerColumnMetaData, java.lang.String pServerColumnName) Returns the specific ServerColumnMetaData column index. -1 if the Column name doesn't exist.
int	getServerColumnMetaDataIndex(java.lang.String pServerColumnName) Returns the specific ServerColumnMetaData column index. -1 if the Column name doesn't exist.
int[]	getWritableColumnIndices() Returns all writable column name indices.
java.lang.String[]	getWritableColumnNames() Returns all writable column names.
void	setAutoIncrementColumnNames(Name[] pAutoIncrementColumnNames) Sets the auto increment column names.
void	setAutoIncrementColumnNames(java.lang.String[] pAutoIncrementColumnNames) Sets the auto increment column names.
void	setMetaData(MetaData pMetaData) Sets all ServerMetaData columns.
void	setPrimaryKeyColumnNames(Name[] pPrimaryKeyColumnNames) Sets the Primary Key column names.
void	setPrimaryKeyColumnNames(java.lang.String[] pPrimaryKeyColumnNames) Sets the Primary Key column names.
void	setPrimaryKeyType(ServerMetaData.PrimaryKeyType pType) Gets the type of the Primary key columns.
void	setRepresentationColumnNames(Name[] pRepresentationColumnNames) Sets the Representation column names.
void	setRepresentationColumnNames(java.lang.String[] pRepresentationColumnNames) Sets the Representation column names.
void	setServerColumnMetaData(ServerColumnMetaData[] pServerColumnMetaData) Adds an new ServerColumnMetaData column.

Methods inherited from class java.lang.Object

clone, 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

getMetaData

public MetaData getMetaData()

Returns the MetaData client infos.

Returns:

the MetaData client infos.

setMetaData

public void setMetaData(MetaData pMetaData)

Sets all ServerMetaData columns.

Parameters:

pMetaData - the meta data.

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)

Adds an new ServerColumnMetaData column.

Parameters:

pServerColumnMetaData - the column meta data to add

getServerColumnMetaData

public ServerColumnMetaData[] getServerColumnMetaData()

Returns all ServerColumnMetaData columns.

Returns:

all ServerColumnMetaData columns.

getServerColumnMetaData

public ServerColumnMetaData getServerColumnMetaData(java.lang.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 exist

getServerColumnMetaData

public ServerColumnMetaData getServerColumnMetaData(int pIndex)

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

Parameters:

pIndex - the column index to use.

Returns:

the specific ServerColumnMetaData column index.

getServerColumnMetaDataIndex

public int getServerColumnMetaDataIndex(java.lang.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.

getServerColumnMetaDataIndex

public static int getServerColumnMetaDataIndex(ServerColumnMetaData[] pServerColumnMetaData,
                                               java.lang.String pServerColumnName)

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

Parameters:

pServerColumnMetaData - the server column meta data.

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.

getWritableColumnNames

public java.lang.String[] getWritableColumnNames()

Returns all writable column names.

Returns:

all writable column names.

getPrimaryKeyColumnIndices

public int[] getPrimaryKeyColumnIndices()

Returns the Primary Key column name indices.

Returns:

the Primary Key column name indices.

getPrimaryKeyColumnNames

public java.lang.String[] getPrimaryKeyColumnNames()

Returns the Primary Key column names.

Returns:

the Primary Key column names.

setPrimaryKeyColumnNames

public void setPrimaryKeyColumnNames(java.lang.String[] pPrimaryKeyColumnNames)

Sets the Primary Key column names.

Parameters:

pPrimaryKeyColumnNames - the Primary Key column names to set

setPrimaryKeyColumnNames

public void setPrimaryKeyColumnNames(Name[] pPrimaryKeyColumnNames)

Sets the Primary Key column names.

Parameters:

pPrimaryKeyColumnNames - the Primary Key column names to set

getRepresentationColumnNames

public java.lang.String[] getRepresentationColumnNames()

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

Returns:

the Representation column names.

setRepresentationColumnNames

public void setRepresentationColumnNames(java.lang.String[] pRepresentationColumnNames)

Sets the Representation column names.

Parameters:

pRepresentationColumnNames - the Representation column names to set

setRepresentationColumnNames

public void setRepresentationColumnNames(Name[] pRepresentationColumnNames)

Sets the Representation column names.

Parameters:

pRepresentationColumnNames - the Representation column names to set

getAutoIncrementColumnNames

public java.lang.String[] getAutoIncrementColumnNames()

Returns the auto increment column names.

Returns:

the auto increment column names.

getAutoIncrementColumnIndices

public int[] getAutoIncrementColumnIndices()

Returns the auto increment column name indices.

Returns:

the auto increment column name indices.

setAutoIncrementColumnNames

public void setAutoIncrementColumnNames(java.lang.String[] pAutoIncrementColumnNames)

Sets the auto increment column names.

Parameters:

pAutoIncrementColumnNames - the auto increment column names. to set

setAutoIncrementColumnNames

public void setAutoIncrementColumnNames(Name[] pAutoIncrementColumnNames)

Sets the auto increment column names.

Parameters:

pAutoIncrementColumnNames - the auto increment column names. to set

getColumnNames

public java.lang.String[] getColumnNames()

Returns all column names of the ColumnMetaData list.

Returns:

all column names of the ColumnMetaData list.

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