|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public static final int DIRECTION_INPUT
public static final int DIRECTION_OUTPUT
public static final int DIRECTION_INPUT_OUTPUT
public static final int DIRECTION_ALL
public static final java.lang.String MAPPABLE_TYPE_OPERATOR
public static final java.lang.String MAPPABLE_TYPE_ATTRIBUTE_GROUP
public static final java.lang.String MAPPABLE_TYPE_ATTRIBUTE
public static final java.lang.String MAPPABLE_TYPE_UNKNOWN
Method Detail |
public boolean canConnectTo(Mappable target) throws OWBException
target
- The target operator to be checked.OWBException
- if any internal error is encountered.public void connectTo(Mappable target) throws MapConnectionFailureException, OWBException
connectOperators
method.target
- The target mappable object.MapConnectionFailureException
- if the attemp to connect to the target encountered error.OWBException
- if any internal error is encountered.public void removeConnections(int direction) throws OWBException
direction
- The direction of the connections to be removed. The choices are:
OWBException
- if any internal error is encountered.public void disconnectFrom(Mappable connectedMappable) throws OWBException
connectedMappable
- The connected mappable from which to remove connections.OWBException
- if any internal error is encountered.public Mappable[] getConnectedMappables(java.lang.String mappableType, int direction) throws OWBException
mappableType
- The type of the mappables to be returned. The choices are:
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:
OWBException
- if any internal error is encountered.public Mappable getParentMappable()
public Map getParentMap()
public java.lang.String getMappableType()
|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |