oracle.dms.table
Interface Schema

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable, oracle.dms.table.TableBase

public interface Schema

extends oracle.dms.table.TableBase

Schema contains the schema of a Table.

Since:

Oracle Application Server 10g (10.1.3)

Field Summary

static java.lang.String	HOST Special column that contains the host where the noun resides.
static java.lang.String	NAME Special column that contains the noun name.
static java.lang.String	PARENT Special column that contains the parent noun name.
static java.lang.String	PROCESS Special column that contains the process where the noun resides.

Method Summary

int	columnCount() Gets the number of the columns in this Table.
int	columnGroupCount() Gets the number of the ColumnGroups in this Table.
boolean	containsColumn(java.lang.String column) Returns true if this Table contains the given column.
boolean	containsColumnGroup(java.lang.String group) Returns true if this Table contains the given column group.
java.util.Enumeration	enumerateColumnDefinitions(boolean sorted) Enumerates ColumnDefinitions in this Table.
java.util.Enumeration	enumerateColumnGroups(boolean sorted) Enumerates ColumnGroups in this Table.
ColumnDefinition	getColumnDefinition(java.lang.String column) Gets the ColumnDefinition of the given column.
ColumnDefinition[]	getColumnDefinitions() Gets the ColumnDefinitions of the columns in an array.
ColumnGroup	getColumnGroup(java.lang.String group) Gets the given ColumnGroup.
java.lang.String[]	getColumnGroupNames() Returns the names of the ColumnGroups in this Table as an array.
ColumnGroup[]	getColumnGroups() Gets the ColumnGroups in this Table as an array.
java.lang.String[]	getColumnNames() Returns the names of the columns in this Table as an array.
java.lang.String	getDescription() Gets the description of the Table.
java.lang.String	getDisplayName() Gets the display name of the Table.
java.lang.String	getNLSID() Gets the NLS ID of the Table.
Table	getTable() Gets the Table containing this object.

Field Detail

NAME

public static final java.lang.String NAME

Special column that contains the noun name.

See Also:

Constant Field Values

PARENT

public static final java.lang.String PARENT

Special column that contains the parent noun name.

See Also:

Constant Field Values

HOST

public static final java.lang.String HOST

Special column that contains the host where the noun resides.

See Also:

Constant Field Values

PROCESS

public static final java.lang.String PROCESS

Special column that contains the process where the noun resides.

See Also:

Constant Field Values

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Gets the display name of the Table.

Returns:

the display name of the Table.

Since:

Oracle Application Server 10g (10.1.3)

getNLSID

public java.lang.String getNLSID()

Gets the NLS ID of the Table.

Returns:

the NLS ID of the Table.

Since:

Oracle Application Server 10g (10.1.3)

getDescription

public java.lang.String getDescription()

Gets the description of the Table.

Returns:

the description of the Table.

Since:

Oracle Application Server 10g (10.1.3)

columnCount

public int columnCount()

Gets the number of the columns in this Table.

Returns:

the number of the columns in this Table.

Since:

Oracle Application Server 10g (10.1.3)

getColumnNames

public java.lang.String[] getColumnNames()

Returns the names of the columns in this Table as an array.

Returns:

the names of the columns in this Table as an array.

Since:

Oracle Application Server 10g (10.1.3)

containsColumn

public boolean containsColumn(java.lang.String column)

Returns true if this Table contains the given column.

Parameters:

column - the column name.

Returns:

true if this Table contains the given column.

getColumnDefinitions

public ColumnDefinition[] getColumnDefinitions()

Gets the ColumnDefinitions of the columns in an array.

Returns:

the ColumnDefinitions of the columns in an array.

Since:

Oracle Application Server 10g (10.1.3)

See Also:

enumerateColumnDefinitions(boolean sorted)

getColumnDefinition

public ColumnDefinition getColumnDefinition(java.lang.String column)

Gets the ColumnDefinition of the given column.

Parameters:

column - column name.

Returns:

the ColumnDefinition of the given column.

Since:

Oracle Application Server 10g (10.1.3)

See Also:

enumerateColumnDefinitions(boolean sorted)

enumerateColumnDefinitions

public java.util.Enumeration enumerateColumnDefinitions(boolean sorted)

Enumerates ColumnDefinitions in this Table.

Parameters:

sorted - true enumerates ColumnDefinitions in the acsending order.

Returns:

Enumeration object for enumerating ColumnDefinition objects in this Table.

Since:

Oracle Application Server 10g (10.1.3)

See Also:

getColumnDefinitions(), getColumnDefinition(String column)

columnGroupCount

public int columnGroupCount()

Gets the number of the ColumnGroups in this Table.

Returns:

the number of the ColumnGroups in this Table.

Since:

Oracle Application Server 10g (10.1.3)

getColumnGroups

public ColumnGroup[] getColumnGroups()

Gets the ColumnGroups in this Table as an array.

Returns:

the ColumnGroups in this Table as an array.

Since:

Oracle Application Server 10g (10.1.3)

See Also:

enumerateColumnGroups(boolean sorted), getColumnGroup(String column)

getColumnGroup

public ColumnGroup getColumnGroup(java.lang.String group)

Gets the given ColumnGroup.

Parameters:

group - column goup name.

Returns:

the given ColumnGroup.

Since:

Oracle Application Server 10g (10.1.3)

See Also:

enumerateColumnGroups(boolean sorted), getColumnGroups()

containsColumnGroup

public boolean containsColumnGroup(java.lang.String group)

Returns true if this Table contains the given column group.

Parameters:

group - the name of the column group.

Returns:

true if this Table contains the given column group.

Since:

Oracle Application Server 10g (10.1.3)

enumerateColumnGroups

public java.util.Enumeration enumerateColumnGroups(boolean sorted)

Enumerates ColumnGroups in this Table.

Parameters:

sorted - true enumerates ColumnGroups in the acsending order.

Returns:

Enumeration object for enumerating ColumnGroup objects in this Table.

Since:

Oracle Application Server 10g (10.1.3)

See Also:

getColumnGroups(), getColumnGroup(String column)

getColumnGroupNames

public java.lang.String[] getColumnGroupNames()

Returns the names of the ColumnGroups in this Table as an array.

Returns:

the names of the ColumnGroups in this Table as an array.

Since:

Oracle Application Server 10g (10.1.3)

getTable

public Table getTable()

Gets the Table containing this object.

Returns:

the Table containing this object.

Since:

Oracle Application Server 10g (10.1.3)