|
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 |
MapAttributeGroup
is the interface that describes an attribute group of an operator. The attribute group has a name and a direction (input, output, or input_output) and contains the MapAttribute
objects.
Field Summary |
Fields inherited from interface oracle.owb.mapping.Mappable |
DIRECTION_ALL, DIRECTION_INPUT, DIRECTION_INPUT_OUTPUT, DIRECTION_OUTPUT, MAPPABLE_TYPE_ATTRIBUTE, MAPPABLE_TYPE_ATTRIBUTE_GROUP, MAPPABLE_TYPE_OPERATOR, MAPPABLE_TYPE_UNKNOWN |
Method Summary | |
void |
autoConnectByName(MapAttributeGroup target, boolean ignoreCase, java.lang.String ignoreSpecialChars, java.lang.String ignoreSourcePrefix, java.lang.String ignoreSourceSuffix, java.lang.String ignoreTargetPrefix, java.lang.String ignoreTargetSuffix) Connect this attribute group to a target attribute group. |
void |
autoConnectByPosition(MapAttributeGroup target) Connect this attribute group to a target attribute group. |
void |
autoConnectCopyAll(MapAttributeGroup target) Connect this attribute group to a target attribute group. |
void |
autoConnectCopyAttributes(MapAttribute[] sourceAttribs, MapAttributeGroup target) Connect this attribute group to a target attribute group. |
boolean |
canCreateAttribute() Determine if an attribute can be added. |
boolean |
canDeleteAttribute(MapAttribute attribute) Determine if the specified operator can be deleted. |
MapAttribute |
createAttribute() Add an attribute with an automatically created default name, and a datatype of NUMBER(0,0). |
MapAttribute |
createAttribute(java.lang.String name) Add an attribute with the specified name, and with the datatype NUMBER(0,0). |
MapAttribute |
createAttribute(java.lang.String name, java.lang.String datatype) Add an attribute with the specified name. |
MapAttribute |
createAttribute(java.lang.String name, java.lang.String datatype, int length) Add an attribute with the specified name. |
MapAttribute |
createAttribute(java.lang.String name, java.lang.String datatype, int precision, int scale) Add an attribute with the specified name. |
MapAttribute |
createAttribute(java.lang.String name, java.lang.String datatype, int length, int precision, int scale) Add an attribute with the specified name. |
MapAttribute |
findAttribute(java.lang.String name) Find the attribute with the specified name. |
MapAttribute |
findAttributeLike(java.lang.String searchString) Find the first attribute who's name contains the specified string. |
int |
getAttributeCount() Returns the number of attributes contained by this group. |
MapAttribute[] |
getAttributes() Get all attributes in the group, in the order they were created. |
int |
getDirection() Retrieve the direction of this attribute group. |
MapOperator |
getOperator() Returns the operator that owns this group. |
Methods inherited from interface oracle.owb.mapping.Mappable |
canConnectTo, connectTo, disconnectFrom, getConnectedMappables, getMappableType, getParentMap, getParentMappable, removeConnections |
Methods inherited from interface oracle.owb.foundation.OWBNamedObject |
delete, getBusinessName, getClassDefinition, getComponent, getDescription, getName, getUOID, isDeletable, isEditable, isRenamable, setBusinessName, setDescription, setName |
Methods inherited from interface oracle.owb.foundation.property.PropertyOwner |
getDefaultPropertyValue, getLogicalPropertyKeys, getPhysicalPropertyKeys, getPropertyDomain, getPropertyKeys, getPropertyValue, getPropertyValueString, isLogicalProperty, isPhysicalProperty, isReadOnlyProperty, setPropertyValue, setPropertyValueByString |
Method Detail |
public MapOperator getOperator()
public MapAttribute[] getAttributes() throws OWBException
OWBException
- if any internal error is encountered.public MapAttribute findAttribute(java.lang.String name) throws OWBException
name
- the name of the attribute to be found.OWBException
- if any internal error is encountered.public MapAttribute findAttributeLike(java.lang.String searchString) throws OWBException
searchString
- the search string.OWBException
- if any internal error is encountered.public MapAttribute createAttribute(java.lang.String name, java.lang.String datatype, int length, int precision, int scale) throws OWBException, NameSpaceException, InvalidFormatException
name
- The name of the new attribute - this name may be modified to make it unique within the set of attributes of this group.datatype
- The data type of the new attribute. This should be one of the constant values specified in the MapDatatypeSet
interface.length
- The length value for the new attribute. Must be consistent with the datatype, or an OWBException will be thrown.scale
- The scale value for the new attribute. Must be consistent with the datatype, or an OWBException will be thrown.precision
- The precision value for the new attribute. Must be consistent with the datatype, or an OWBException will be thrown.OWBException
- if any internal error is encountered.NameSpaceException
- if attribute with same name already exists.InvalidFormatException
- if name contains invalid character.public MapAttribute createAttribute(java.lang.String name, java.lang.String datatype) throws OWBException, NameSpaceException, InvalidFormatException
name
- The name of the new attribute - this name may be modified to make it unique within the set of attributes of this group.datatype
- The data type of the new attribute. This should be one of the constant values specified in the MapDatatypeSet
interface.OWBException
- if any internal error is encountered.NameSpaceException
- if attribute with same name already exists.InvalidFormatException
- if name contains invalid character.public MapAttribute createAttribute(java.lang.String name, java.lang.String datatype, int length) throws OWBException, NameSpaceException, InvalidFormatException
name
- The name of the new attribute - this name may be modified to make it unique within the set of attributes of this group.datatype
- The data type of the new attribute. This should be one of the constant values specified in the MapDatatypeSet
interface.length
- The length value for the new attribute. Must be consistent with the datatype, or an OWBException will be thrown.OWBException
- if any internal error is encountered.NameSpaceException
- if attribute with same name already exists.InvalidFormatException
- if name contains invalid character.public MapAttribute createAttribute(java.lang.String name, java.lang.String datatype, int precision, int scale) throws OWBException, NameSpaceException, InvalidFormatException
name
- The name of the new attribute - this name may be modified to make it unique within the set of attributes of this group.datatype
- The data type of the new attribute. This should be one of the constant values specified in the MapDatatypeSet
interface.scale
- The scale value for the new attribute. Must be consistent with the datatype, or an OWBException will be thrown.precision
- The precision value for the new attribute. Must be consistent with the datatype, or an OWBException will be thrown.OWBException
- if any internal error is encountered.NameSpaceException
- if attribute with same name already exists.InvalidFormatException
- if name contains invalid character.public MapAttribute createAttribute(java.lang.String name) throws OWBException, NameSpaceException, InvalidFormatException
name
- The name of the new attribute - this name may be modified to make it unique within the set of attributes of this group.OWBException
- if any internal error is encountered.NameSpaceException
- if attribute with same name already exists.InvalidFormatException
- if name contains invalid character.public MapAttribute createAttribute() throws OWBException, NameSpaceException, InvalidFormatException
OWBException
- if any internal error is encountered.NameSpaceException
- if attribute with same name already exists.InvalidFormatException
- if name contains invalid character.public boolean canDeleteAttribute(MapAttribute attribute)
attribute
- the attribute to be deleted.public boolean canCreateAttribute()
public int getDirection() throws OWBException
OWBException
- if any internal error is encountered.public void autoConnectCopyAttributes(MapAttribute[] sourceAttribs, MapAttributeGroup target) throws OWBException
sourceAttribs
- The source attributes to be copied and connected. The source attributes must all be owned by this attribute group.target
- The target group.OWBException
- if any internal error is encountered.public void autoConnectCopyAll(MapAttributeGroup target) throws OWBException
target
- The target group.OWBException
- if any internal error is encountered.public void autoConnectByName(MapAttributeGroup target, boolean ignoreCase, java.lang.String ignoreSpecialChars, java.lang.String ignoreSourcePrefix, java.lang.String ignoreSourceSuffix, java.lang.String ignoreTargetPrefix, java.lang.String ignoreTargetSuffix) throws OWBException
target
- The target group.ignoreCase
- If true, case is ignored when comparing the namesignoreSpecialChars
- A string containing special characters that will be ignored when comparing the names. If null, no special characters are defined.ignoreSourcePrefix
- A source prefix that will be ignored when comparing the names. If null, no prefix is defined.ignoreSourceSuffix
- A source suffix that will be ignored when comparing the names. If null, no suffix is defined.ignoreTargetPrefix
- A target prefix that will be ignored when comparing the names. If null, no prefix is defined.ignoreTargetSuffix
- A target suffix that will be ignored when comparing the names. If null, no suffix is defined.OWBException
- if any internal error is encountered.public void autoConnectByPosition(MapAttributeGroup target) throws OWBException
OWBException
- if any internal error is encountered.public int getAttributeCount() throws OWBException
OWBException
- if any internal error is encountered.
|
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 |