oracle.odi.domain.mapping

Class MapConnectorPointRole

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.root.Root

oracle.odi.domain.mapping.MapConnectorPointRole

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity, IPropertyDefinitionOwner, IMappingObject, IRoot

public class MapConnectorPointRole
extends Root
implements IPropertyDefinitionOwner

A class to store the characteristics of a set of component connector points with a specific role or purpose. A typical simple component type would have one input connector point role and one output connector point role, but the component framework supports multiple types of roles for each direction. Connector point roles are owned by a component type object and are created and registered at the same time as the component type.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNLIMITED Set max input or map output connector count to this value if the number of allowed connectors is unlimited.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPropertyDefinition(PropertyDefinition propDef)
PropertyDefinition	findPropertyDefinition(java.lang.String ownerClass, java.lang.String name) Finds the property definition with the specified name, or null if not found.
oracle.odi.domain.mapping.MapAttributeInfo	getDefaultAttribute(java.lang.String name) Find a default attribute definition (MapAttributeInfo) owned by this connector point role, with the specified name.
int	getDefaultAttributeCount() Get the number of default attributes created when a connector point with this role is created.
java.util.List	getDefaultAttributes() Return the list of default attribute definition objects owned by this connector point role.
int	getDefaultConnectorCount() Return the number of connector points with this role that are created by default when the component is created.
MapConnectorPoint.Direction	getDirection() Return the direction of this connector point role, INPUT or OUTPUT.
java.lang.String	getDisplayableTypeName() Get a displayable type name for the property owner object.
int	getMaxAttributeCount() Return the maximum number of attributes that can be owned by a connector point with this role.
int	getMaxConnectorCount() Return the maximum number of connector points with this role that are allowed to be owned by the component.
int	getMaxExpressionCount() Return the number of expressions that are allowed to be owned by attributes that are owned by a connector point with this role.
java.lang.String	getName() Get the name for this object.
IRoot	getOwner() Gets the mapping owner (or parent) of this object.
MapComponentType	getOwningComponentType() Get the component type object that owns this role.
java.util.List	getPropertyDefinitions() Get the list of property definitions owned by this connector point role.
boolean	isAttributeBindingSupported() Return true if attributes owned by a connector point with this role are allowed to be bound to a model object.
boolean	isConnectorPointBindingSupported() Return true if a connector point associated with this role supports binding to a model object at the connector point level.
boolean	isCreateUnboundAttributeAllowed() Return true if a connector point with this role is allowed to create a new unbound attribute.
boolean	isDefaultRole() Return true if this is the default role for it's direction.
boolean	isPassive() Return true if the output of a connector point with this role is passive.
void	removePropertyDefinition(PropertyDefinition propDef) Remove the property definition from this owner.
java.lang.String	toString()

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.odi.domain.root.IRoot

dump, dump, getDisplayableObjectName, getGUID, getStrongTypeClassName, validate, validate, validate

Methods inherited from interface oracle.odi.domain.root.IMappingObject

getRootContainer

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getInternalId, getSecurityContainer

Field Detail

UNLIMITED

public static final int UNLIMITED

Set max input or map output connector count to this value if the number of allowed connectors is unlimited.

See Also:

Constant Field Values

Constructor Detail

MapConnectorPointRole

public MapConnectorPointRole(MapComponentType owner,
                     java.lang.String name,
                     java.lang.String guid,
                     MapConnectorPoint.Direction direction)

Parameters:

owner -

name -

guid -

direction -

Method Detail

getOwner

public IRoot getOwner()

Description copied from interface: IRoot

Gets the mapping owner (or parent) of this object. Some objects may have an external adapter owner and would return null from this method - for example the mapping object is owned by an adapter container (e.g. OdiFolder) object, which is not an instance of IRoot, so null would be returned.

Specified by:

getOwner in interface IRoot

Specified by:

getOwner in class Root

Returns:

The owner class instance.

getPropertyDefinitions

public java.util.List getPropertyDefinitions()

Get the list of property definitions owned by this connector point role. These property definitions are used to create properties when a connector point with this role is created. A property definition with owning class type of connector point can also be created at the component level, but those definitions will create properties for every connector point. A property definition owned by a connector point role will define a property that is only added to connector points with the owning role

Returns:

The list of property definitions owned by this role.

addPropertyDefinition

public void addPropertyDefinition(PropertyDefinition propDef)

Specified by:

addPropertyDefinition in interface IPropertyDefinitionOwner

removePropertyDefinition

public void removePropertyDefinition(PropertyDefinition propDef)

Description copied from interface: IPropertyDefinitionOwner

Remove the property definition from this owner.

Specified by:

removePropertyDefinition in interface IPropertyDefinitionOwner

Parameters:

propDef - The definition to be removed.

getName

public java.lang.String getName()

Description copied from interface: IRoot

Get the name for this object.

Specified by:

getName in interface IPropertyDefinitionOwner

Specified by:

getName in interface IRoot

Overrides:

getName in class Root

Returns:

the name of property definition owner.

getOwningComponentType

public MapComponentType getOwningComponentType()

Get the component type object that owns this role.

Returns:

THe owning component type object.

isDefaultRole

public boolean isDefaultRole()

Return true if this is the default role for it's direction. The default role is the role that will be used when creating new connector points, if no role is explicitly specified.

getDirection

public MapConnectorPoint.Direction getDirection()

Return the direction of this connector point role, INPUT or OUTPUT. This is the direction of the connector points that get created using this role.

Returns:

The direction property for this role.

isPassive

public boolean isPassive()

Return true if the output of a connector point with this role is passive. The output is passive if it does not define any new row cardinality, and its data can be combined with data from another output without using a join component. An example of a passive output would be a constant, variable value, or sequence component output.

isConnectorPointBindingSupported

public boolean isConnectorPointBindingSupported()

Return true if a connector point associated with this role supports binding to a model object at the connector point level.

getDefaultConnectorCount

public int getDefaultConnectorCount()

Return the number of connector points with this role that are created by default when the component is created.

Returns:

The number of connector points created by default.

getMaxConnectorCount

public int getMaxConnectorCount()

Return the maximum number of connector points with this role that are allowed to be owned by the component. The value can be UNLIMITED, which means that an unlimited number of connector points of this role are allowed. The value must be greater than 0.

Returns:

The maximum number of connector points of this role allowed in the component.

getDefaultAttributeCount

public int getDefaultAttributeCount()

Get the number of default attributes created when a connector point with this role is created.

Returns:

The number of default attribute definitions owned by this role.

getMaxAttributeCount

public int getMaxAttributeCount()

Return the maximum number of attributes that can be owned by a connector point with this role. The value can be 0, meaning that the connector point cannot have any attributes. The value can be UNLIMITED, meaning that the connector point can own an unlimited number of attributes.

Returns:

THe maximum number of attributes for this role.

isCreateUnboundAttributeAllowed

public boolean isCreateUnboundAttributeAllowed()

Return true if a connector point with this role is allowed to create a new unbound attribute. For example, an expression component may create new unbound attriubtes and set an expression for each one.

isAttributeBindingSupported

public boolean isAttributeBindingSupported()

Return true if attributes owned by a connector point with this role are allowed to be bound to a model object. For example, a datastore component attribute may be bound to a column model object.

getDefaultAttributes

public java.util.List getDefaultAttributes()

Return the list of default attribute definition objects owned by this connector point role. The default attribute definition objects are used to create default attributes when a connector point with this role is created.

Returns:

The list of MapAttributeInfo objects owned by this role.

getDefaultAttribute

public oracle.odi.domain.mapping.MapAttributeInfo getDefaultAttribute(java.lang.String name)

Find a default attribute definition (MapAttributeInfo) owned by this connector point role, with the specified name. Return null if not found.

Parameters:

name -

Returns:

The default attribute info object.

getMaxExpressionCount

public int getMaxExpressionCount()

Return the number of expressions that are allowed to be owned by attributes that are owned by a connector point with this role. A typical value is one, for many simple components. The value can be UNLIMITED, which means that an unlimited number of expressions can be owned by each attribute. An example of a connector point role with unlimited expression count per attribute would be the set component output connector point role. Each expression represents one item in the select list of one of the queries in the query set. The actual number of expressions would match the number of input connector points.

Returns:

The maximum number of expressions allowed to be owned by attributes of connector points of this role.

findPropertyDefinition

public PropertyDefinition findPropertyDefinition(java.lang.String ownerClass,
                                        java.lang.String name)

Description copied from interface: IPropertyDefinitionOwner

Finds the property definition with the specified name, or null if not found.

Specified by:

findPropertyDefinition in interface IPropertyDefinitionOwner

Parameters:

ownerClass - the owner class name.

name - the name of the property the property definition defines.

Returns:

a property definition or null if not found.

toString

public java.lang.String toString()

Overrides:

toString in class Root

getDisplayableTypeName

public java.lang.String getDisplayableTypeName()

Description copied from class: Root

Get a displayable type name for the property owner object.

Specified by:

getDisplayableTypeName in interface IRoot

Specified by:

getDisplayableTypeName in class Root

Returns:

The displayable type name.