oracle.owb.mapping
Interface MapAttributeGroup

All Superinterfaces:

Extensible, Mappable, OWBNamedObject, PropertyOwner

public interface MapAttributeGroup

extends Mappable, OWBNamedObject, Extensible, PropertyOwner

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

getOperator

public MapOperator getOperator()

Returns the operator that owns this group.

Returns:

The operator that owns this group.

getAttributes

public MapAttribute[] getAttributes()
                             throws OWBException

Get all attributes in the group, in the order they were created.

Returns:

The array of attributes.

Throws:

OWBException - if any internal error is encountered.

findAttribute

public MapAttribute findAttribute(java.lang.String name)
                           throws OWBException

Find the attribute with the specified name.

Parameters:

name - the name of the attribute to be found.

Returns:

The attribute, null if not found.

Throws:

OWBException - if any internal error is encountered.

findAttributeLike

public MapAttribute findAttributeLike(java.lang.String searchString)
                               throws OWBException

Find the first attribute who's name contains the specified string.

Parameters:

searchString - the search string.

Returns:

The attribute, null if not found.

Throws:

OWBException - if any internal error is encountered.

createAttribute

public MapAttribute createAttribute(java.lang.String name,
                                    java.lang.String datatype,
                                    int length,
                                    int precision,
                                    int scale)
                             throws OWBException,
NameSpaceException,
InvalidFormatException

Add an attribute with the specified name. The specified name may be modified to ensure that the new attribute is uniquely named within the group.

Parameters:

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.

Returns:

The newly created attribute.

Throws:

OWBException - if any internal error is encountered.

NameSpaceException - if attribute with same name already exists.

InvalidFormatException - if name contains invalid character.

createAttribute

public MapAttribute createAttribute(java.lang.String name,
                                    java.lang.String datatype)
                             throws OWBException,
NameSpaceException,
InvalidFormatException

Add an attribute with the specified name. The specified name may be modified to ensure that the new attribute is uniquely named within the group.

Parameters:

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.

Returns:

The newly created attribute.

Throws:

OWBException - if any internal error is encountered.

NameSpaceException - if attribute with same name already exists.

InvalidFormatException - if name contains invalid character.

createAttribute

public MapAttribute createAttribute(java.lang.String name,
                                    java.lang.String datatype,
                                    int length)
                             throws OWBException,
NameSpaceException,
InvalidFormatException

Add an attribute with the specified name. This is a convenience method for adding attributes with character data type, since the length can be specified. The specified name may be modified to ensure that the new attribute is uniquely named within the group.

Parameters:

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.

Returns:

The newly created attribute.

Throws:

OWBException - if any internal error is encountered.

NameSpaceException - if attribute with same name already exists.

InvalidFormatException - if name contains invalid character.

createAttribute

public MapAttribute createAttribute(java.lang.String name,
                                    java.lang.String datatype,
                                    int precision,
                                    int scale)
                             throws OWBException,
NameSpaceException,
InvalidFormatException

Add an attribute with the specified name. This is a convenience method for adding attributes with numeric data type, since the scale and precision can be specified. The specified name may be modified to ensure that the new attribute is uniquely named within the group.

Parameters:

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.

Returns:

The newly created attribute.

Throws:

OWBException - if any internal error is encountered.

NameSpaceException - if attribute with same name already exists.

InvalidFormatException - if name contains invalid character.

createAttribute

public MapAttribute createAttribute(java.lang.String name)
                             throws OWBException,
NameSpaceException,
InvalidFormatException

Add an attribute with the specified name, and with the datatype NUMBER(0,0).

Parameters:

name - The name of the new attribute - this name may be modified to make it unique within the set of attributes of this group.

Returns:

The newly created attribute.

Throws:

OWBException - if any internal error is encountered.

NameSpaceException - if attribute with same name already exists.

InvalidFormatException - if name contains invalid character.

createAttribute

public MapAttribute createAttribute()
                             throws OWBException,
NameSpaceException,
InvalidFormatException

Add an attribute with an automatically created default name, and a datatype of NUMBER(0,0).

Returns:

The newly created attribute.

Throws:

OWBException - if any internal error is encountered.

NameSpaceException - if attribute with same name already exists.

InvalidFormatException - if name contains invalid character.

canDeleteAttribute

public boolean canDeleteAttribute(MapAttribute attribute)

Determine if the specified operator can be deleted.

Parameters:

attribute - the attribute to be deleted.

Returns:

true if the attribute can be deleted; false otherwise.

canCreateAttribute

public boolean canCreateAttribute()

Determine if an attribute can be added.

Returns:

true if an attribute can be added, else false.

getDirection

public int getDirection()
                 throws OWBException

Retrieve the direction of this attribute group.

Returns:

The direction. Should be equal to one of the following:

• Mappable.DIRECTION_INPUT
• Mappable.DIRECTION_OUTPUT
• Mappable.DIRECTION_INPUT_OUTPUT

Throws:

OWBException - if any internal error is encountered.

autoConnectCopyAttributes

public void autoConnectCopyAttributes(MapAttribute[] sourceAttribs,
MapAttributeGroup target)
                               throws OWBException

Connect this attribute group to a target attribute group. Copies the specified source attributes to the target group, then connects the source attributes to the newly created target attributes.

Parameters:

sourceAttribs - The source attributes to be copied and connected. The source attributes must all be owned by this attribute group.

target - The target group.

Throws:

OWBException - if any internal error is encountered.

autoConnectCopyAll

public void autoConnectCopyAll(MapAttributeGroup target)
                        throws OWBException

Connect this attribute group to a target attribute group. Copies all of the source attributes to the target group, then connects the source attributes to the newly created target attributes.

Parameters:

target - The target group.

Throws:

OWBException - if any internal error is encountered.

autoConnectByName

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

Connect this attribute group to a target attribute group. Connects all source attributes that have a target attribute with a matching name, to the matching target attribute. Special name matching arguments are provided.

Parameters:

target - The target group.

ignoreCase - If true, case is ignored when comparing the names

ignoreSpecialChars - 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.

Throws:

OWBException - if any internal error is encountered.

autoConnectByPosition

public void autoConnectByPosition(MapAttributeGroup target)
                           throws OWBException

Connect this attribute group to a target attribute group. Connects all source attributes to target attributes with a matching position within the group.

Throws:

OWBException - if any internal error is encountered.

getAttributeCount

public int getAttributeCount()
                      throws OWBException

Returns the number of attributes contained by this group.

Returns:

The number of attributes in the group.

Throws:

OWBException - if any internal error is encountered.