com.metamatrix.common.vdb.api
Interface ModelInfo

All Known Implementing Classes:

BasicModelInfo

public interface ModelInfo

This interface provides the model information.

Field Summary

static short	PRIVATE
static java.lang.String	PRIVATE_VISIBILITY
static short	PUBLIC
static java.lang.String	PUBLIC_VISIBILITY

Method Summary

void	enableMutliSourceBindings(boolean isEnabled) Enable the model to have multiple connector bindings associated by passing in true.
java.util.List	getConnectorBindingNames() Return the connector binding name(s).
java.util.Date	getDateVersioned() Get the date this model was versioned.
java.io.InputStream	getDDLFileContentsAsStream(java.lang.String ddlFileName) Get the contents of the given DDL file name.
byte[]	getDDLFileContentsGetBytes(java.lang.String ddlFileName) Get the contents of the given DDL file name.
java.lang.String[]	getDDLFileNames() Get the list of DDL file names that can be used to generate this materialization.
java.lang.String	getDescription() Get this model's description.
int	getModelType() Return the type of model
java.lang.String	getModelTypeName() Returns the String version of the model type.
java.lang.String	getModelURI() Return the model uri.
java.lang.String	getName() Get this model's name.
java.lang.String	getPath()
java.lang.String	getUUID() Get this model's UUID.
java.lang.String	getVersion() Get this model's verion.
java.lang.String	getVersionedBy() Get the name of the person who versioned this model.
short	getVisibility()
boolean	isMaterialization() Check whether this model is a materialization of a virtual group.
boolean	isMultiSourceBindingEnabled() Returns true if the model has been enabled to have multiple connector bindings assigned.
boolean	isPhysical() Whether this is a physical model.
boolean	isVisible() Returns true if the model is visible to the use for querying
boolean	requiresConnectorBinding() Whether this model requires that a connector must be bound to it.
void	setDDLFiles(java.util.Map ddlFileNamesToFiles) Set the Map of DDL file names to DDL file byte arrays.
boolean	supportsMultiSourceBindings() Returns true if the model, based on its model type, supports multiple connector bindings.

Field Detail

PRIVATE

static final short PRIVATE

See Also:

Constant Field Values

PUBLIC

static final short PUBLIC

See Also:

Constant Field Values

PRIVATE_VISIBILITY

static final java.lang.String PRIVATE_VISIBILITY

See Also:

Constant Field Values

PUBLIC_VISIBILITY

static final java.lang.String PUBLIC_VISIBILITY

See Also:

Constant Field Values

Method Detail

getUUID

java.lang.String getUUID()

Get this model's UUID.

Returns:

The UUID as a String.

getName

java.lang.String getName()

Get this model's name.

Returns:

The Model name.

getDescription

java.lang.String getDescription()

Get this model's description.

Returns:

The Model description.

getVersion

java.lang.String getVersion()

Get this model's verion.

Returns:

The Model's version.

getDateVersioned

java.util.Date getDateVersioned()

Get the date this model was versioned.

Returns:

The model's version date.

getVersionedBy

java.lang.String getVersionedBy()

Get the name of the person who versioned this model.

Returns:

The name of the Model versioner.

isPhysical

boolean isPhysical()

Whether this is a physical model.

Returns:

true if this is a physicalmodel.

requiresConnectorBinding

boolean requiresConnectorBinding()

Whether this model requires that a connector must be bound to it.

Returns:

true if this model requires a connector.

getConnectorBindingNames

java.util.List getConnectorBindingNames()

Return the connector binding name(s). The only time this list would have more than one connector binding name, is if the model supports (@see #supportsMultiSourceBindings()).

Returns:

Since:

4.2

supportsMultiSourceBindings

boolean supportsMultiSourceBindings()

Returns true if the model, based on its model type, supports multiple connector bindings. If true, isMultiSourceBindingEnabled() to determine if the model has been flagged so that the user can actually assign multi-connector bindings.

Returns:

Since:

4.2

isMultiSourceBindingEnabled

boolean isMultiSourceBindingEnabled()

Returns true if the model has been enabled to have multiple connector bindings assigned.

Returns:

Since:

4.2

isVisible

boolean isVisible()

Returns true if the model is visible to the use for querying

Returns:

boolean

getVisibility

short getVisibility()

isMaterialization

boolean isMaterialization()

Check whether this model is a materialization of a virtual group.

Returns:

Returns the isMaterialization.

Since:

4.2

getDDLFileNames

java.lang.String[] getDDLFileNames()

Get the list of DDL file names that can be used to generate this materialization.

If this model is not a materialization, the returned String[] will be empty.

Returns:

A list of file names of DDL file names contained in the VDB.

Since:

4.2

See Also:

getDDLFileContentsAsStream(String)

getDDLFileContentsAsStream

java.io.InputStream getDDLFileContentsAsStream(java.lang.String ddlFileName)

Get the contents of the given DDL file name.

Parameters:

ddlFileName - The name for which to get the DDL.

Returns:

The stream contents of the DDL file or null if this modle has no DDL for the given file name or is not a materialization.

Since:

4.2

See Also:

getDDLFileNames()

getDDLFileContentsGetBytes

byte[] getDDLFileContentsGetBytes(java.lang.String ddlFileName)

Get the contents of the given DDL file name.

Parameters:

ddlFileName - The name for which to get the DDL.

Returns:

The byte[] contents of the DDL file or null if this model has no DDL for the given file name or is not a materialization.

Since:

4.2

See Also:

getDDLFileNames()

setDDLFiles

void setDDLFiles(java.util.Map ddlFileNamesToFiles)

Set the Map of DDL file names to DDL file byte arrays.

Parameters:

ddlFileNamesToFiles - The Map String->byte[];

Since:

4.2

getModelType

int getModelType()

Return the type of model

Returns:

getModelURI

java.lang.String getModelURI()

Return the model uri.

Returns:

getModelTypeName

java.lang.String getModelTypeName()

Returns the String version of the model type.

Returns:

enableMutliSourceBindings

void enableMutliSourceBindings(boolean isEnabled)

Enable the model to have multiple connector bindings associated by passing in true.

Parameters:

isEnabled -

Since:

4.2

See Also:

to determine if the model is enabled. Just because a model supports mutliple bindings, does not mean it will be enabled.

getPath

java.lang.String getPath()