com.metamatrix.metadata.runtime.model
Class BasicModel

java.lang.Object
  com.metamatrix.metadata.runtime.model.BasicMetadataObject
      com.metamatrix.metadata.runtime.model.BasicModel

All Implemented Interfaces:

MetadataObject, Model, java.io.Serializable

public class BasicModel
extends BasicMetadataObject
implements Model

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.metamatrix.metadata.runtime.api.Model

PRIVATE, PUBLIC

Constructor Summary

BasicModel(BasicModelID modelID, BasicVirtualDatabaseID virtualDBID)
Call constructor to instantiate a runtime object by passing the RuntimeID that identifies the entity and the VIrtualDatabaseID that identifes the Virtual Database the object will be contained.

BasicModel(BasicModelID modelID, BasicVirtualDatabaseID virtualDBID, ModelInfo mInfo)

Method Summary

void	addConnectorBindingName(java.lang.String connectrBindingName)
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.lang.String	getDescription() Return the description
java.lang.String	getGUID() Return the global unique identifier for this Virtual Databse.
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	getVersion()
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() Return boolean indicating if this model is of a physical type.
boolean	isVisible() Returns true if the model is visible to the use for querying
boolean	requireConnectorBinding() Return boolean indicating whether the model requires connector bindings.
void	setConnectorBindingNames(java.util.Collection bindings)
void	setDescription(java.lang.String desc)
void	setGUID(java.lang.String guid)
void	setIsVisible(boolean isVisible)
void	setModelType(int type)
void	setModelURI(java.lang.String uri)
void	setVersionDate(java.util.Date date)
void	setVersionedBy(java.lang.String versionedBy)
void	setVisibility(short visibility)
boolean	supportsMultiSourceBindings() Returns true if the model, based on its model type, supports mutliple connector bindings.
java.lang.String	toString() Returns a string representing the current state of the object.

Methods inherited from class com.metamatrix.metadata.runtime.model.BasicMetadataObject

addProperty, clone, compareTo, equals, getAlias, getCurrentProperties, getFullName, getID, getName, getNameInSource, getPath, getProperties, getVirtualDatabaseID, hashCode, hasNameInSource, setID, setProperties

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.metamatrix.metadata.runtime.api.MetadataObject

clone, compareTo, equals, getFullName, getID, getName, getProperties, getVirtualDatabaseID

Constructor Detail

BasicModel

public BasicModel(BasicModelID modelID,
                  BasicVirtualDatabaseID virtualDBID)

Call constructor to instantiate a runtime object by passing the RuntimeID that identifies the entity and the VIrtualDatabaseID that identifes the Virtual Database the object will be contained.

BasicModel

public BasicModel(BasicModelID modelID,
                  BasicVirtualDatabaseID virtualDBID,
                  ModelInfo mInfo)

Method Detail

getDescription

public java.lang.String getDescription()

Description copied from interface: Model

Return the description

Specified by:

getDescription in interface Model

Returns:

String

isPhysical

public boolean isPhysical()

Description copied from interface: Model

Return boolean indicating if this model is of a physical type.

Specified by:

isPhysical in interface Model

Returns:

boolean true if it contains physical group(s).

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface Model

isVisible

public boolean isVisible()

Description copied from interface: Model

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

Specified by:

isVisible in interface Model

Returns:

boolean

isMultiSourceBindingEnabled

public boolean isMultiSourceBindingEnabled()

Description copied from interface: Model

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

Specified by:

isMultiSourceBindingEnabled in interface Model

Returns:

Since:

4.2

See Also:

ModelInfo.isMultiSourceBindingEnabled()

requireConnectorBinding

public boolean requireConnectorBinding()

Description copied from interface: Model

Return boolean indicating whether the model requires connector bindings.

Specified by:

requireConnectorBinding in interface Model

Returns:

boolean

getGUID

public java.lang.String getGUID()

Description copied from interface: Model

Return the global unique identifier for this Virtual Databse.

Specified by:

getGUID in interface Model

Returns:

String

getConnectorBindingNames

public java.util.List getConnectorBindingNames()

Description copied from interface: Model

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()).

Specified by:

getConnectorBindingNames in interface Model

Returns:

Since:

4.2

See Also:

Model.getConnectorBindingNames()

supportsMultiSourceBindings

public boolean supportsMultiSourceBindings()

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

Specified by:

supportsMultiSourceBindings in interface Model

Returns:

Since:

4.2

See Also:

Model.supportsMultiSourceBindings()

getModelType

public int getModelType()

Description copied from interface: Model

Return the type of model

Specified by:

getModelType in interface Model

Returns:

getModelTypeName

public java.lang.String getModelTypeName()

Description copied from interface: Model

Returns the String version of the model type.

Specified by:

getModelTypeName in interface Model

Returns:

getModelURI

public java.lang.String getModelURI()

Description copied from interface: Model

Return the model uri.

Specified by:

getModelURI in interface Model

Returns:

getDateVersioned

public java.util.Date getDateVersioned()

Description copied from interface: Model

Get the date this model was versioned.

Specified by:

getDateVersioned in interface Model

Returns:

The model's version date.

getVersionedBy

public java.lang.String getVersionedBy()

Description copied from interface: Model

Get the name of the person who versioned this model.

Specified by:

getVersionedBy in interface Model

Returns:

The name of the Model versioner.

isMaterialization

public boolean isMaterialization()

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

Specified by:

isMaterialization in interface Model

Returns:

Returns the isMaterialization.

Since:

4.2

getVisibility

public short getVisibility()

Specified by:

getVisibility in interface Model

setDescription

public void setDescription(java.lang.String desc)

setGUID

public void setGUID(java.lang.String guid)

enableMutliSourceBindings

public void enableMutliSourceBindings(boolean isEnabled)

Description copied from interface: Model

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

Specified by:

enableMutliSourceBindings in interface Model

Since:

4.2

See Also:

ModelInfo.enableMutliSourceBindings(boolean)

addConnectorBindingName

public void addConnectorBindingName(java.lang.String connectrBindingName)

setConnectorBindingNames

public void setConnectorBindingNames(java.util.Collection bindings)

setModelType

public void setModelType(int type)

setVersionDate

public void setVersionDate(java.util.Date date)

Parameters:

date -

setVersionedBy

public void setVersionedBy(java.lang.String versionedBy)

Parameters:

versionedBy -

setModelURI

public void setModelURI(java.lang.String uri)

setIsVisible

public void setIsVisible(boolean isVisible)

setVisibility

public void setVisibility(short visibility)

toString

public java.lang.String toString()

Description copied from class: BasicMetadataObject

Returns a string representing the current state of the object.

Specified by:

toString in interface MetadataObject

Overrides:

toString in class BasicMetadataObject

Returns:

the string representation of this instance.