oracle.odi.domain.mapping.component

Class AggregateComponent

java.lang.Object

oracle.odi.domain.mapping.MapComponentDelegator

oracle.odi.domain.mapping.MapComponentDelegate

oracle.odi.domain.mapping.component.DefaultDelegate

oracle.odi.domain.mapping.component.AggregateComponent

All Implemented Interfaces:

IModelObject, IModelObjectBase, IMapComponent, IRepositoryEntity, IMapComponentOwner, IMappingObject, INamedObject, IPropertyOwner, IRoot

public class AggregateComponent
extends DefaultDelegate

AggregateComponent is a mapping component used in processing expressions containing aggregation functions. It also allows specification of attributes used in the SQL group-by and having clauses associated with aggregation.

Since:

12.1.2.0.0

Version:

$Header: odi/src/javadev/odi.mapping/src/oracle/odi/domain/mapping/component/AggregateComponent.java /main/34 2016/09/27 16:35:38 dwenberg Exp $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AggregateComponent.IsGroupByColumn The IsGroupByColumn enumeration specifies whether a column is included in the GROUP BY clause.

Nested classes/interfaces inherited from class oracle.odi.domain.mapping.component.DefaultDelegate

DefaultDelegate.DefaultAttributeDelegate, DefaultDelegate.DefaultConnectorPointDelegate

Nested classes/interfaces inherited from class oracle.odi.domain.mapping.MapComponentDelegate

oracle.odi.domain.mapping.MapComponentDelegate.AttributeDelegate, oracle.odi.domain.mapping.MapComponentDelegate.MapConnectorPointDelegate

Nested classes/interfaces inherited from interface oracle.odi.domain.mapping.IMapComponent

IMapComponent.ComponentCategory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE_NAME The component type name for this component.
static java.lang.String	PROPKEY_AUTOCOMPUTE_GROUPBY
static java.lang.String	PROPKEY_GROUPBY
static java.lang.String	PROPKEY_HAVING
static java.lang.String	PROPKEY_MANUAL_GROUPBY_CLAUSE

Fields inherited from class oracle.odi.domain.mapping.component.DefaultDelegate

VARIABLE_COMPONENT_TYPE_NAME

Fields inherited from class oracle.odi.domain.mapping.MapComponentDelegate

JAVA_LOGGER

Constructor Summary

Constructors

Constructor and Description
AggregateComponent(oracle.odi.domain.mapping.MapComponentOwner owner, java.lang.String name) Construct a new persistent set component.

Method Summary

Modifier and Type	Method and Description
MapAttribute	addAttribute(java.lang.String name, java.lang.String pExpressionText, IDataType pDataType, java.lang.Integer pSize, java.lang.Integer pScale) Adds a new attribute to this component
MapExpression.ExecuteOnLocation	getExecuteOnHint() Return an execute location hint if the component supports it, otherwise "NO_HINT".
java.lang.String	getGroupByAuto(ITechnology pTechnology) Gets the SQL GROUP BY string as a comma separated list of attributes, based on calculation of all attributes not containing an aggregation function in the expression.
MapExpression	getHaving() Gets the map expression for the HAVING clause.
java.lang.String	getHavingText() Gets the HAVING clause expression text.
MapExpression	getManualGroupBy() Gets the manual group-by clause expression for this component.
void	setAutoComputeGroupBy(java.lang.Boolean pAutoComputeGroupBy) Sets the automatic group-by clause computation for this component.
void	setExecuteOnHint(MapExpression.ExecuteOnLocation hint) Set the execute-on hint for this component, if applicable, otherwise throw exception.
void	setHavingText(java.lang.String pHaving) Sets the expression for the SQL HAVING clause.
void	setManualGroupBy(java.lang.String text) Sets the expression text for the manual group-by expression.
void	setPropertyValue(java.lang.String key, java.lang.Object value) Set a property value for the property with the specified key name.

Methods inherited from class oracle.odi.domain.mapping.component.DefaultDelegate

customInvalidateExpressions, customSyncComponent, getBlockExpressionReferencedAttributes, getBlockExpressionReferencedAttributesWithPath, getExecuteOnHintString, getIntegrationType, getNextAvailableInput, getNextAvailableInput, getNextAvailableOutput, isAddInputConnectorPointAllowed, isAddOutputConnectorPointAllowed, isPassive, setExecuteOnHintByString

Methods inherited from class oracle.odi.domain.mapping.MapComponentDelegate

afterAddComponent, afterConnect, afterPropertyChange, afterRemoveComponent, beforePropertyChange, connectFrom, createInputConnectorPoint, createInputConnectorPoint, createOutputConnectorPoint, createOutputConnectorPoint, customValidateProposedChildConnection, customValidateProposedChildScoping, equals, getBoundObjectFullName, getBoundObjectName, getBoundShortcutFullName, getComponentContext, getComponentCustomLocation, getComponentType, getInScopeAttributeXMap, getSQLAccessName, getSQLAliasName, getTechnicalDescription, getTypeName, handleChildMapChangeEvent, handleMapChangeEvent, hashCode, initPhysicalNode, isAttributeExecuteOnLocationHidden, isBoundObjectDeleted, isCardinalitySource, isCompositeComponentType, isExpressionHidden, isTargetLoadingSupported, propertyValueGetterHook, setComponentType, supportComponentOfType, toString, validateReorderComponent

Methods inherited from class oracle.odi.domain.mapping.MapComponentDelegator

addComponent, addProperty, bindTo, bindTo, connectTo, connectTo, connectTo, connectTo, containsComponent, createComponent, createComponent, createComponent, createOutputConnectorPoint, createProperty, disableMapChangeEventHandling, dump, dump, enableMapChangeEventHandling, findAllComponents, findComponent, findComponentBoundTo, findComponentOfType, findComponentsBoundTo, findConnector, findConnectorPoint, findInputAttribute, findOutputAttribute, findSubComponentOwner, generateUniqueComponentName, generateUniqueComponentName, generateUniqueConnectorName, generateUniqueName, generateUniqueName, getAdapter, getAlias, getAllComponents, getAllComponentsOfType, getAllExpressions, getAllProperties, getAllSignatureOwnerHolders, getAllSubComponentOwners, getAttributeExpressions, getAttributes, getBigNumericId, getBooleanPropertyValue, getBoundObject, getBoundShortcut, getBoundTechnology, getBusinessName, getCachedIssues, getComponentAttributeMap, getComponentCategory, getComponentCount, getComponentLocation, getComponentLocation, getComponentOwner, getComponents, getComponentTypeName, getConcreteObject, getConnectorPointCount, getConnectorPointCount, getConnectorPoints, getConnectorPoints, getConnectorPointToLeaf, getConnectorTo, getDelegate, getDescription, getDisplayableObjectName, getDisplayableProperties, getDisplayableTypeName, getDomainInterfaceType, getDownstreamConnectedLeafComponents, getDownstreamConnectedPoints, getExpressionPropertyValue, getExpressionReferences, getFlowConstraints, getFullName, getGlobalId, getGUID, getInputConnectorPoint, getInputConnectorPoint, getInputConnectorPointCount, getInputConnectorPoints, getInputPoint, getInScopeAttributes, getInternalId, getIntPropertyValue, getLeafLevelComponents, getLeafLevelEndpoints, getLeafLevelTargets, getMapRootContainer, getName, getNumericId, getOutputAttributeExpressions, getOutputAttributes, getOutputConnectorPoint, getOutputConnectorPoint, getOutputConnectorPointCount, getOutputConnectorPoints, getOutputPoint, getOwner, getOwningComponent, getParent, getPersistentClassName, getPrefix, getProjectedAttributes, getProperties, getProperty, getPropertyDefinitionOwner, getPropertyValue, getPropertyValueReference, getProposedConnectionIssues, getQualifiedName, getRootComponentOwner, getRootContainer, getSecurityContainer, getSources, getStringPropertyValue, getStrongTypeClassName, getSyncState, getTargetLoadOrder, getTargetLoadOrderText, getTargets, getTopLevelComponentsOfType, getTopLevelSignatureOwnerHolders, getTopLevelSources, getTopLevelTargets, getTopmostComponent, getUpstreamAttributeXMap, getUpstreamConnectedLeafComponents, getUpstreamConnectedLeafPoints, getUpstreamConnectedPoints, getUpstreamInScopeLeafAttributes, getUpstreamInScopeLeafComponentsFor, getUpstreamInScopeLeafPoints, getUpstreamLeafAttributes, getUpstreamLeafAttributes, getUpstreamLeafConnectorPoints, getUpstreamLeafConnectorPoints, getUpstreamLeafSources, getUpstreamSources, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor, invokeMethod, is11gMapping, isBound, isComponent, isComponentLevelConnectAllowed, isCompositeComponent, isCreatePersistentComponents, isDecorator, isEndpoint, isExpandableComponent, isHidden, isInScope, isInScope, isMapChangeEventHandlingEnabled, isMultiInputSelector, isOfType, isProjector, isPropertyDefined, isProposedConnectionValid, isSelector, isSignatureOwner, isSignatureOwnerHolder, isSource, isSubComponent, isTarget, isUniqueComponentName, isUniqueComponentName, referencesObject, removeAllConnections, removeAllConnections, removeAllInputConnections, removeComponent, removeComponent, removeInputConnectorPoint, removeInputConnectorPoint, removeInputConnectorPoint, removeOutputConnectorPoint, removeOutputConnectorPoint, removeProperty, reorderInputConnectorPoint, reorderOutputConnectorPoint, setAlias, setAttributeExpressionText, setAttributeExpressionText, setBooleanPropertyValue, setBusinessName, setDescription, setIntPropertyValue, setIsHidden, setName, syncComponent, validate, validate, validate, validateProperties

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

COMPONENT_TYPE_NAME

public static final java.lang.String COMPONENT_TYPE_NAME

The component type name for this component. Must match the name in Definitions.xml.

See Also:

Constant Field Values

PROPKEY_HAVING

public static final java.lang.String PROPKEY_HAVING

See Also:

Constant Field Values

PROPKEY_GROUPBY

public static final java.lang.String PROPKEY_GROUPBY

See Also:

Constant Field Values

PROPKEY_AUTOCOMPUTE_GROUPBY

public static final java.lang.String PROPKEY_AUTOCOMPUTE_GROUPBY

See Also:

Constant Field Values

PROPKEY_MANUAL_GROUPBY_CLAUSE

public static final java.lang.String PROPKEY_MANUAL_GROUPBY_CLAUSE

See Also:

Constant Field Values

Constructor Detail

AggregateComponent

public AggregateComponent(oracle.odi.domain.mapping.MapComponentOwner owner,
                          java.lang.String name)
                   throws MappingException,
                          AdapterException

Construct a new persistent set component.

Parameters:

owner - The component owner that will own the new component.

name - The name for the new component.

Throws:

oracle.odi.domain.mapping.exception.MapComponentException

AdapterException

MappingException

Method Detail

addAttribute

public MapAttribute addAttribute(java.lang.String name,
                                 java.lang.String pExpressionText,
                                 IDataType pDataType,
                                 java.lang.Integer pSize,
                                 java.lang.Integer pScale)
                          throws MappingException,
                                 AdapterException

Adds a new attribute to this component

Parameters:

name - attribute name

pExpressionText - Expression text

pDataType - attribute data type

pSize - attribute numeric precision or character length

pScale - attribute numeric scale

Returns:

new attribute

Throws:

MappingException

AdapterException

setHavingText

public void setHavingText(java.lang.String pHaving)
                   throws MappingException,
                          AdapterException

Sets the expression for the SQL HAVING clause.

Parameters:

pHaving - HAVING clause expression.

Throws:

MappingException

AdapterException

getHaving

public MapExpression getHaving()
                        throws PropertyException

Gets the map expression for the HAVING clause.

Returns:

HAVING clause expression.

Throws:

PropertyException

getHavingText

public java.lang.String getHavingText()
                               throws PropertyException

Gets the HAVING clause expression text.

Returns:

HAVING clause text.

Throws:

PropertyException

getGroupByAuto

public java.lang.String getGroupByAuto(ITechnology pTechnology)
                                throws MappingException,
                                       AdapterException

Gets the SQL GROUP BY string as a comma separated list of attributes, based on calculation of all attributes not containing an aggregation function in the expression.

Parameters:

pTechnology - The technology, used to determine whether aggregation functions are used in the expression.

Returns:

group-by string.

Throws:

MappingException

AdapterException

setAutoComputeGroupBy

public void setAutoComputeGroupBy(java.lang.Boolean pAutoComputeGroupBy)
                           throws PropertyException

Sets the automatic group-by clause computation for this component.

Parameters:

pAutoComputeGroupBy - true to enable automatic group-by column computation, otherwise false.

Throws:

PropertyException

getManualGroupBy

public MapExpression getManualGroupBy()
                               throws PropertyException

Gets the manual group-by clause expression for this component. The manual group by clause overrides automatic computation of the group-by clause.

Returns:

Map expression for the manual group-by clause.

Throws:

PropertyException

setManualGroupBy

public void setManualGroupBy(java.lang.String text)
                      throws MappingException,
                             AdapterException

Sets the expression text for the manual group-by expression. The manual group by clause overrides automatic computation of the group-by clause.

Parameters:

text - manual group-by expression text.

Throws:

MappingException

AdapterException

getExecuteOnHint

public MapExpression.ExecuteOnLocation getExecuteOnHint()
                                                 throws PropertyException

Description copied from interface: IMapComponent

Return an execute location hint if the component supports it, otherwise "NO_HINT".

Overrides:

getExecuteOnHint in class DefaultDelegate

Throws:

PropertyException

setExecuteOnHint

public void setExecuteOnHint(MapExpression.ExecuteOnLocation hint)
                      throws PropertyException

Description copied from interface: IMapComponent

Set the execute-on hint for this component, if applicable, otherwise throw exception.

Overrides:

setExecuteOnHint in class DefaultDelegate

Throws:

PropertyException

setPropertyValue

public void setPropertyValue(java.lang.String key,
                             java.lang.Object value)
                      throws PropertyException

Description copied from interface: IPropertyOwner

Set a property value for the property with the specified key name.

Specified by:

setPropertyValue in interface IPropertyOwner

Overrides:

setPropertyValue in class oracle.odi.domain.mapping.MapComponentDelegator

Parameters:

key - The name of the property whose value will be set.

value - The object value of the property. The interpretation of the object type will be determined by the type of the property.

Throws:

PropertyException