com.metamatrix.common.config.model
Class BasicComponentType

java.lang.Object
  com.metamatrix.common.namedobject.BasicObject
      com.metamatrix.common.config.model.BasicComponentType

All Implemented Interfaces:

ComponentType, BaseObject, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

Direct Known Subclasses:

BasicAuthenticationProviderType, BasicConnectorBindingType, BasicHostType, BasicProductServiceConfigType, BasicProductType, BasicResourceComponentType, BasicServiceComponentType, BasicVMComponentDefnType

public class BasicComponentType
extends BasicObject
implements ComponentType, java.io.Serializable

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.metamatrix.common.config.api.ComponentType

AUTHPROVIDER_COMPONENT_TYPE_CODE, CONFIGURATION_COMPONENT_TYPE_CODE, CONNECTOR_COMPONENT_TYPE_CODE, DEPLOYED_COMPONENT_TYPE_CODE, HOST_COMPONENT_TYPE_CODE, PRODUCT_COMPONENT_TYPE_CODE, PSC_COMPONENT_TYPE_CODE, RESOURCE_COMPONENT_TYPE_CODE, SERVICE_COMPONENT_TYPE_CODE, VM_COMPONENT_TYPE_CODE

Constructor Summary

protected

BasicComponentType(BasicComponentType type)

Method Summary

void	accept(ConfigurationVisitor visitor)
void	addComponentTypeDefinition(ComponentTypeDefn defn)
java.lang.Object	clone() Return a deep cloned instance of this object.
int	getComponentTypeCode() Returns int indicating the component type code;
ComponentTypeDefn	getComponentTypeDefinition(java.lang.String name) Returns the ComponentTypeDefn for the specified name
java.util.Collection	getComponentTypeDefinitions() Returns the Collection of ComponentTypeDefns that are defined for this component type
java.lang.String	getCreatedBy() Returns the principal who created this type
java.util.Date	getCreatedDate() Returns the Date this type was created
java.lang.String	getCreatedDateString()
java.util.Properties	getDefaultPropertyValues() Returns the default values for this component type.
java.lang.String	getDefaultValue(java.lang.String propertyName) Returns the String representation of the default value for the requested property.
java.lang.String	getDescription() Returns the description, if it has one, of the component type
java.lang.String	getLastChangedBy() Returns the principal who last modified this type
java.util.Date	getLastChangedDate() Returns the Date this type was last changed
java.lang.String	getLastChangedDateString()
java.util.Collection	getMaskedPropertyNames() Returns the List of properties that are defined as masked for this component type.
ComponentTypeID	getParentComponentTypeID() Returns the parent component type id
ComponentTypeID	getSuperComponentTypeID() Returns the super component type id
boolean	isDeployable() Returns true is the component type is considered deployable within a configuration.
boolean	isDeprecated() Returns true if this component type is no longer used
boolean	isMonitored() Returns true if this component type is monitored
boolean	isOfConnectorProductType() Returns true if this component type is a member of the connectors product type based on
boolean	isOfTypeConnector() Returns true if this component type is a connector type
boolean	isOfTypeXAConnector() Returns true if this component type is a XA connector type.
void	removeComponentTypeDefinition(ComponentTypeDefn defn)
void	setComponentTypeCode(int code)
void	setComponentTypeDefinitions(java.util.Collection newDefinitions)
void	setCreatedBy(java.lang.String createdBy)
void	setCreatedDate(java.lang.String createdDate)
void	setDescription(java.lang.String desc)
void	setIsDeprecated(boolean deprecate)
void	setLastChangedBy(java.lang.String lastChangedBy)
void	setLastChangedDate(java.lang.String lastChangedDate)
void	setParentComponentTypeID(ComponentTypeID typeID)
void	setSuperComponentTypeID(ComponentTypeID typeID)

Methods inherited from class com.metamatrix.common.namedobject.BasicObject

compareTo, equals, getFullName, getID, getName, hashCode, setID, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.metamatrix.common.namedobject.BaseObject

getFullName, getID, getName

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

BasicComponentType

protected BasicComponentType(BasicComponentType type)

Method Detail

getComponentTypeDefinitions

public java.util.Collection getComponentTypeDefinitions()

Description copied from interface: ComponentType

Returns the Collection of ComponentTypeDefns that are defined for this component type

Specified by:

getComponentTypeDefinitions in interface ComponentType

Returns:

Set of ComponentTypeDefn

getComponentTypeDefinition

public ComponentTypeDefn getComponentTypeDefinition(java.lang.String name)

Description copied from interface: ComponentType

Returns the ComponentTypeDefn for the specified name

Specified by:

getComponentTypeDefinition in interface ComponentType

Returns:

ComponentTypeDefn of ComponentTypeDefn

getDefaultValue

public java.lang.String getDefaultValue(java.lang.String propertyName)

Description copied from interface: ComponentType

Returns the String representation of the default value for the requested property.

Specified by:

getDefaultValue in interface ComponentType

Returns:

getDefaultPropertyValues

public java.util.Properties getDefaultPropertyValues()

Description copied from interface: ComponentType

Returns the default values for this component type. Note, it does not return the defaults from its super component type. To obtain all default properties, call

Specified by:

getDefaultPropertyValues in interface ComponentType

Returns:

getMaskedPropertyNames

public java.util.Collection getMaskedPropertyNames()

Description copied from interface: ComponentType

Returns the List of properties that are defined as masked for this component type.

Specified by:

getMaskedPropertyNames in interface ComponentType

Since:

4.3

See Also:

ComponentType.getMaskedPropertyNames()

getDescription

public java.lang.String getDescription()

Returns the description, if it has one, of the component type

Specified by:

getDescription in interface ComponentType

Returns:

String description

Since:

4.2

getParentComponentTypeID

public ComponentTypeID getParentComponentTypeID()

Description copied from interface: ComponentType

Returns the parent component type id

Specified by:

getParentComponentTypeID in interface ComponentType

Returns:

ComponentType parent

getSuperComponentTypeID

public ComponentTypeID getSuperComponentTypeID()

Description copied from interface: ComponentType

Returns the super component type id

Specified by:

getSuperComponentTypeID in interface ComponentType

Returns:

ComponentType parent

getComponentTypeCode

public int getComponentTypeCode()

Description copied from interface: ComponentType

Returns int indicating the component type code;

Specified by:

getComponentTypeCode in interface ComponentType

Returns:

int

isDeployable

public boolean isDeployable()

Description copied from interface: ComponentType

Returns true is the component type is considered deployable within a configuration.

Specified by:

isDeployable in interface ComponentType

Returns:

boolean true if the component type is deployable

isDeprecated

public boolean isDeprecated()

Description copied from interface: ComponentType

Returns true if this component type is no longer used

Specified by:

isDeprecated in interface ComponentType

Returns:

boolean true if deprecated

isMonitored

public boolean isMonitored()

Description copied from interface: ComponentType

Returns true if this component type is monitored

Specified by:

isMonitored in interface ComponentType

Returns:

boolean true if monitored

isOfTypeConnector

public boolean isOfTypeConnector()

Description copied from interface: ComponentType

Returns true if this component type is a connector type

Specified by:

isOfTypeConnector in interface ComponentType

Returns:

boolean true if a connector type

isOfConnectorProductType

public boolean isOfConnectorProductType()

Returns true if this component type is a member of the connectors product type based on

Specified by:

isOfConnectorProductType in interface ComponentType

Returns:

boolean true if a member of the connectors product type

isOfTypeXAConnector

public boolean isOfTypeXAConnector()

Description copied from interface: ComponentType

Returns true if this component type is a XA connector type. If this is true, then @link #isOfTypeConnector() will also be true. However, @link #isOfTypeConnector() can be true and this can be false.

Specified by:

isOfTypeXAConnector in interface ComponentType

Returns:

boolean true if a connector type

getCreatedBy

public java.lang.String getCreatedBy()

Returns the principal who created this type

Specified by:

getCreatedBy in interface ComponentType

Returns:

String principal name

setCreatedBy

public void setCreatedBy(java.lang.String createdBy)

getCreatedDate

public java.util.Date getCreatedDate()

Returns the Date this type was created

Specified by:

getCreatedDate in interface ComponentType

Returns:

Date this type was created

getCreatedDateString

public java.lang.String getCreatedDateString()

setCreatedDate

public void setCreatedDate(java.lang.String createdDate)

getLastChangedBy

public java.lang.String getLastChangedBy()

Returns the principal who last modified this type

Specified by:

getLastChangedBy in interface ComponentType

Returns:

String principal name

setLastChangedBy

public void setLastChangedBy(java.lang.String lastChangedBy)

getLastChangedDate

public java.util.Date getLastChangedDate()

Returns the Date this type was last changed

Specified by:

getLastChangedDate in interface ComponentType

Returns:

Date this type was last changed

getLastChangedDateString

public java.lang.String getLastChangedDateString()

setLastChangedDate

public void setLastChangedDate(java.lang.String lastChangedDate)

setComponentTypeDefinitions

public void setComponentTypeDefinitions(java.util.Collection newDefinitions)

setParentComponentTypeID

public void setParentComponentTypeID(ComponentTypeID typeID)

setSuperComponentTypeID

public void setSuperComponentTypeID(ComponentTypeID typeID)

setIsDeprecated

public void setIsDeprecated(boolean deprecate)

setComponentTypeCode

public void setComponentTypeCode(int code)

setDescription

public void setDescription(java.lang.String desc)

addComponentTypeDefinition

public void addComponentTypeDefinition(ComponentTypeDefn defn)

removeComponentTypeDefinition

public void removeComponentTypeDefinition(ComponentTypeDefn defn)

clone

public java.lang.Object clone()

Return a deep cloned instance of this object. Subclasses must override this method.

Specified by:

clone in interface BaseObject

Overrides:

clone in class BasicObject

Returns:

the object that is the clone of this instance.

accept

public void accept(ConfigurationVisitor visitor)

Specified by:

accept in interface ComponentType