oracle.olapi.metadata.mdm
Class MdmTable

java.lang.Object
  oracle.olapi.metadata.BaseMetadataObject
      oracle.olapi.metadata.mdm.MdmObject
          oracle.olapi.metadata.mdm.MdmSource
              oracle.olapi.metadata.mdm.MdmTable

All Implemented Interfaces:

MdmQuery, MetadataObject

public class MdmTable
extends MdmSource
implements MdmQuery

An MdmSource that represents a table in a relational database. You get an MdmTable by calling the getTopLevelObject method of an MdmDatabaseSchema. For example, the following code gets the MdmTable for the UNITS_FACT relational table.

 MdmTable unitsTable = null;
 Query cubeQuery = null;
 String tableName = "UNITS_FACT";

 try 
 {
   unitsTable = (MdmTable)
                 mdmDBSchema.getTopLevelObject(tableName); 
   cubeQuery = unitsTable.getQuery();
 }
 catch (Exception ex) 
 {
   println("Could not get the " + tableName + " table. " + ex);
 }

Method Summary

java.lang.Object	acceptVisitor(MdmObjectVisitor visitor, java.lang.Object context) Calls the visitMdmTable method of the MdmObjectVisitor and passes that method this MdmTable and an Object.
void	addColumn(MdmColumn value) Adds an MdmColumn to the List of MdmColumn objects that are associated with this MdmTable.
java.util.List<MdmColumn>	getColumns() Gets the MdmColumn objects that are associated with this MdmTable.
MdmDatabaseSchema	getOwner() Gets the MdmDatabaseSchema that owns this MdmTable.
Query	getQuery() Gets the Query that is associated with this MdmTable.
MdmQueryColumn	getQueryColumn(java.lang.String name) Gets the specified MdmQueryColumn.
java.util.List<MdmQueryColumn>	getQueryColumns() Gets the MdmQueryColumn objects that are associated with this MdmTable.
java.lang.String	getQueryName() Gets the identifier of this MdmTable.
void	removeColumn(MdmColumn value) Removes an MdmColumn from the List of MdmColumn objects that are associated with this MdmTable.
void	setOwner(MdmDatabaseSchema owner) Specifies an MdmDatabaseSchema as the owner of this MdmTable.

Methods inherited from class oracle.olapi.metadata.mdm.MdmSource

getDataType, getSource, getType

Methods inherited from class oracle.olapi.metadata.mdm.MdmObject

addDescription, addObjectClassification, findOrCreateDescription, getDescription, getDescription, getDescription, getDescriptions, getMetadataProvider, getName, getNewName, getObjectClassifications, getShortDescription, isClassifiedAs, removeDescription, removeObjectClassification, setDescription, setDescription, setDescription, setName, setShortDescription

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject

getContainedByObject, getID

Methods inherited from class java.lang.Object

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

Method Detail

acceptVisitor

public java.lang.Object acceptVisitor(MdmObjectVisitor visitor,
                                      java.lang.Object context)

Calls the visitMdmTable method of the MdmObjectVisitor and passes that method this MdmTable and an Object.

Specified by:

acceptVisitor in class MdmObject

Parameters:

visitor - An MdmObjectVisitor that implements the Mdm11_ObjectVisitor interface.

context - An Object.

Returns:

The Object returned by the visitMdmTable method.

getColumns

public final java.util.List<MdmColumn> getColumns()

Gets the MdmColumn objects that are associated with this MdmTable.

Returns:

A List of the MdmColumn objects associated with this MdmTable.

addColumn

public void addColumn(MdmColumn value)

Adds an MdmColumn to the List of MdmColumn objects that are associated with this MdmTable.

Parameters:

value - The MdmColumn to add to this MdmTable.

removeColumn

public void removeColumn(MdmColumn value)

Removes an MdmColumn from the List of MdmColumn objects that are associated with this MdmTable.

Parameters:

value - The MdmColumn to remove from this MdmTable.

getOwner

public final MdmDatabaseSchema getOwner()

Gets the MdmDatabaseSchema that owns this MdmTable.

Overrides:

getOwner in class BaseMetadataObject

Returns:

The MdmDatabaseSchema that owns this MdmTable.

setOwner

public final void setOwner(MdmDatabaseSchema owner)

Specifies an MdmDatabaseSchema as the owner of this MdmTable.

Parameters:

owner - The MdmDatabaseSchema to specify as the owner of this MdmTable.

getQuery

public final Query getQuery()

Gets the Query that is associated with this MdmTable.

Specified by:

getQuery in interface MdmQuery

Returns:

The Query associated with this MdmTable.

getQueryColumns

public final java.util.List<MdmQueryColumn> getQueryColumns()

Gets the MdmQueryColumn objects that are associated with this MdmTable. The MdmQueryColumn objects for an MdmTable are instances of MdmColumn, so the List returned by this method has the same objects as the List returned by the getColumns method.

Specified by:

getQueryColumns in interface MdmQuery

Returns:

A List of the MdmQueryColumn objects associated with this MdmTable.

getQueryName

public final java.lang.String getQueryName()

Gets the identifier of this MdmTable.

Specified by:

getQueryName in interface MdmQuery

Returns:

A String that contains the identifier of this MdmTable.

getQueryColumn

public MdmQueryColumn getQueryColumn(java.lang.String name)

Gets the specified MdmQueryColumn.

Specified by:

getQueryColumn in interface MdmQuery

Parameters:

name - A String that contains the name of an MdmQueryColumn.

Returns:

The MdmQueryColumn that has the specified name.