oracle.owb.mapping
Interface Mappable

All Known Subinterfaces:

MapAttribute, MapAttributeGroup, MapOperator

public interface Mappable

Mappable is the interface that describes a mappable object in a map, that can be connected to other mappable objects.

Field Summary

static int	DIRECTION_ALL Constant used to specify direction of a mappable.
static int	DIRECTION_INPUT Constant used to specify direction of a mappable.
static int	DIRECTION_INPUT_OUTPUT Constant used to specify direction of a mappable.
static int	DIRECTION_OUTPUT Constant used to specify direction of a mappable.
static java.lang.String	MAPPABLE_TYPE_ATTRIBUTE Constant used to specify a MapAttribute mappable type.
static java.lang.String	MAPPABLE_TYPE_ATTRIBUTE_GROUP Constant used to specify a MapAttributeGroup mappable type.
static java.lang.String	MAPPABLE_TYPE_OPERATOR Constant used to specify a MapOperator mappable type.
static java.lang.String	MAPPABLE_TYPE_UNKNOWN Constant used to specify an unknown mappable type.

Method Summary

boolean	canConnectTo(Mappable target) Returns true if this mappable can be connected to the specified target.
void	connectTo(Mappable target) Connect this mappable to another mappable.
void	disconnectFrom(Mappable connectedMappable) Remove connections from this mappable to the specified mappable.
Mappable[]	getConnectedMappables(java.lang.String mappableType, int direction) Return an array of all mappables or the specified type that are connected to/from this mappable, in the specififed direction.
java.lang.String	getMappableType() Get this mappable's mappable type.
Map	getParentMap() Get this mappable's parent map.
Mappable	getParentMappable() Get this mappable's parent, if any.
void	removeConnections(int direction) Remove connections in the specified direction from this mappable.

Field Detail

DIRECTION_INPUT

public static final int DIRECTION_INPUT

Constant used to specify direction of a mappable.

DIRECTION_OUTPUT

public static final int DIRECTION_OUTPUT

Constant used to specify direction of a mappable.

DIRECTION_INPUT_OUTPUT

public static final int DIRECTION_INPUT_OUTPUT

Constant used to specify direction of a mappable.

DIRECTION_ALL

public static final int DIRECTION_ALL

Constant used to specify direction of a mappable.

MAPPABLE_TYPE_OPERATOR

public static final java.lang.String MAPPABLE_TYPE_OPERATOR

Constant used to specify a MapOperator mappable type.

MAPPABLE_TYPE_ATTRIBUTE_GROUP

public static final java.lang.String MAPPABLE_TYPE_ATTRIBUTE_GROUP

Constant used to specify a MapAttributeGroup mappable type.

MAPPABLE_TYPE_ATTRIBUTE

public static final java.lang.String MAPPABLE_TYPE_ATTRIBUTE

Constant used to specify a MapAttribute mappable type.

MAPPABLE_TYPE_UNKNOWN

public static final java.lang.String MAPPABLE_TYPE_UNKNOWN

Constant used to specify an unknown mappable type.

Method Detail

canConnectTo

public boolean canConnectTo(Mappable target)
                     throws OWBException

Returns true if this mappable can be connected to the specified target.

Parameters:

target - The target operator to be checked.

Returns:

true if the connection can be made, else false.

Throws:

OWBException - if any internal error is encountered.

connectTo

public void connectTo(Mappable target)
               throws MapConnectionFailureException,
                      OWBException

Connect this mappable to another mappable. To use this method, this mappable must be an output or input/output mappable. Also, the target mappable must be an input or input/output mappable owned by a different operator. It is not allowed to connect directly to or from an operator itself - to do this see the MapUtility connectOperators method.

Parameters:

target - The target mappable object.

Throws:

MapConnectionFailureException - if the attemp to connect to the target encountered error.

OWBException - if any internal error is encountered.

removeConnections

public void removeConnections(int direction)
                       throws OWBException

Remove connections in the specified direction from this mappable.

Parameters:

direction - The direction of the connections to be removed. The choices are:

• MapAttributeGroup.DIRECTION_INPUT - remove all all incoming connections
• MapAttributeGroup.DIRECTION_OUTPUT - remove all outgoing connections
• MapAttributeGroup.DIRECTION_ALL - remove all connections

Throws:

OWBException - if any internal error is encountered.

disconnectFrom

public void disconnectFrom(Mappable connectedMappable)
                    throws OWBException

Remove connections from this mappable to the specified mappable.

Parameters:

connectedMappable - The connected mappable from which to remove connections.

Throws:

OWBException - if any internal error is encountered.

getConnectedMappables

public Mappable[] getConnectedMappables(java.lang.String mappableType,
                                        int direction)
                                 throws OWBException

Return an array of all mappables or the specified type that are connected to/from this mappable, in the specififed direction.

Parameters:

mappableType - The type of the mappables to be returned. The choices are:

• Mappable.MAPPABLE_TYPE_OPERATOR
• Mappable.MAPPABLE_TYPE_ATTRIBUTE_GROUP
• Mappable.MAPPABLE_TYPE_ATTRIBUTE

direction - Specifies the direction of the connections to be returned. For example, specifying "DIRECTION_INPUT" returns all the output mappables that are connected into this input attribute. This is mainly useful for input/output mappables, where there may be some connections going in and some going out. Specifying "DIRECTION_ALL" returns all connected mappables. The choices are:

• Mappable.DIRECTION_INPUT
• Mappable.DIRECTION_OUTPUT
• Mappable.DIRECTION_ALL

Returns:

The array of connected attributes.

Throws:

OWBException - if any internal error is encountered.

getParentMappable

public Mappable getParentMappable()

Get this mappable's parent, if any.

Returns:

The parent mappable. If this is the top (MapOperator) level, then null is returned.

getParentMap

public Map getParentMap()

Get this mappable's parent map.

Returns:

The parent map.

getMappableType

public java.lang.String getMappableType()

Get this mappable's mappable type.

Returns:

The mappable type. The choices are:

• Mappable.MAPPABLE_TYPE_OPERATOR
• Mappable.MAPPABLE_TYPE_ATTRIBUTE_GROUP
• Mappable.MAPPABLE_TYPE_ATTRIBUTE