UnpivotComponent (Oracle Fusion Middleware Java API Reference for Oracle Data Integrator)

java.lang.Object
- MapComponentDelegate
- - oracle.odi.domain.mapping.component.DefaultDelegate
  - - oracle.odi.domain.mapping.component.UnpivotComponent

public class UnpivotComponent
extends DefaultDelegate

Unpivot Component organize the unpivot configuration information into the component's properties e.g. given source data store as following structure:

 SALES
  ID YEAR(NUMERIC) Q1_SALES(NUMERIC) Q2_SALES(NUMERIC) Q3_SALES(NUMERIC) Q4_SALES(NUMERIC)
  11 2010          1000              1000              1000              1000
  12 2011          2000              2000              2000              2000 
  12 2012          2000              3000              4000              5000 
  
 UNPIVOT_COMPONENT
  Key Locator: QUARTER
  Value Locator: SALES
  
  Attributes:
    ID 
    YEAR(NUMERIC) 
    QUARTER(VARCHAR2) 
    SALES(NUMERIC)
    
  Unpivot Transforms
    QUARTER  SALES
    'Q1'     SALES.Q1_SALES
    'Q2'     SALES.Q2_SALES
    'Q3'     SALES.Q3_SALES
    'Q4'     SALES.Q4_SALES
  The unpivot transform rules will be organized as properties pairs and persisted as following into key/value locator's properties
    UNPIVOT_TRANSFORM_K_0 : 'Q1'            QUARTER.PROPERTIES
    UNPIVOT_TRANSFORM_V_0 : SALES.Q1_SALES  SALES.PROPERTIES
    
    UNPIVOT_TRANSFORM_K_1 : 'Q2'            QUARTER.PROPERTIES
    UNPIVOT_TRANSFORM_V_1 : SALES.Q2_SALES  SALES.PROPERTIES
    
    UNPIVOT_TRANSFORM_K_2 : 'Q3'            QUARTER.PROPERTIES
    UNPIVOT_TRANSFORM_V_2 : SALES.Q3_SALES  SALES.PROPERTIES
    
    UNPIVOT_TRANSFORM_K_3 : 'Q4'            QUARTER.PROPERTIES
    UNPIVOT_TRANSFORM_V_3 : SALES.Q4_SALES  SALES.PROPERTIES

Nested Class Summary
- Nested classes/interfaces inherited from class oracle.odi.domain.mapping.component.DefaultDelegate
  DefaultDelegate.DefaultAttributeDelegate, DefaultDelegate.DefaultConnectorPointDelegate

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`	`UNPIVOT_ROW_LOCATOR_PROPKEY`
`static java.lang.String`	`UNPIVOT_TRANSFORM_K_PROPKEY_PREFIX`
`static java.lang.String`	`UNPIVOT_TRANSFORM_V_PROPKEY_PREFIX`

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

Constructor Summary

Constructors
Constructor and Description
`UnpivotComponent(MapComponent component)` For internal use only.
`UnpivotComponent(MapComponentOwner owner, java.lang.String name)` Construct a new persistent distinct component.

Method Summary

doclet.All_Methods doclet.Instance_Methods doclet.Concrete_Methods
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)`
`void`	`addTransform(java.lang.String keyExpr, java.lang.String valExpr)`
`Property`	`addTransformKey(java.lang.String keyExpr)`
`void`	`addTransforms(java.lang.String keyExpr, java.util.Map locatorExprs)`
`MapExpression.ExecuteOnLocation`	`getCompositeExecuteOnHint()`
`MapAttribute`	`getRowLocator()`
`java.util.List`	`getRowLocatorCandidates()`
`java.util.Map`	`getTransformExpressions(Property keyProp)`
`java.util.Collection`	`getTransformKeys()`
`MapAttribute`	`getValueLocator()`
`java.util.List`	`getValueLocators()`
`boolean`	`isIncludeNulls()`
`boolean`	`isValidForTechnology(ITechnology techno, java.util.List issues)`
`void`	`removeTransform(Property transformKey)`
`void`	`setCompositeExecuteOnHint(MapExpression.ExecuteOnLocation hint)` Set all execute on hints for all expression attributes to the specified value.
`void`	`setIncludeNulls(boolean includeNulls)`
`void`	`setRowLocator(MapAttribute rowLocator)`
`void`	`setTransformExpressions(Property keyProp, java.util.Map vLocatorExprs)`

Methods inherited from class oracle.odi.domain.mapping.component.DefaultDelegate
customInvalidateExpressions, customSyncComponent, getBlockExpressionReferencedAttributes, getBlockExpressionReferencedAttributesWithPath, getExecuteOnHint, getExecuteOnHintString, getIntegrationType, getNextAvailableInput, getNextAvailableInput, getNextAvailableOutput, isAddInputConnectorPointAllowed, isAddOutputConnectorPointAllowed, isPassive, setExecuteOnHint, setExecuteOnHintByString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- UNPIVOT_TRANSFORM_K_PROPKEY_PREFIX
```
public static final java.lang.String UNPIVOT_TRANSFORM_K_PROPKEY_PREFIX
```
  See Also:
  
  Constant Field Values
- UNPIVOT_TRANSFORM_V_PROPKEY_PREFIX
```
public static final java.lang.String UNPIVOT_TRANSFORM_V_PROPKEY_PREFIX
```
  See Also:
  
  Constant Field Values
- UNPIVOT_ROW_LOCATOR_PROPKEY
```
public static final java.lang.String UNPIVOT_ROW_LOCATOR_PROPKEY
```
  See Also:
  
  Constant Field Values
- 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

Constructor Detail
- UnpivotComponent
```
public UnpivotComponent(MapComponent component)
                 throws MappingException
```
  For internal use only.
  
  Parameters:
  
  component -
  
  Throws:
  
  MapComponentException
  
  MappingException
- UnpivotComponent
```
public UnpivotComponent(MapComponentOwner owner,
                        java.lang.String name)
                 throws MappingException,
                        AdapterException
```
  Construct a new persistent distinct component.
  
  Parameters:
  
  owner - The component owner that will own the new component.
  
  name - The name for the new component.
  
  Throws:
  
  PropertyException
  
  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

Throws:: MappingException; AdapterException

getCompositeExecuteOnHint

public MapExpression.ExecuteOnLocation getCompositeExecuteOnHint()
                                                          throws PropertyException,
                                                                 MappingException

Throws:: PropertyException; MappingException

setCompositeExecuteOnHint

public void setCompositeExecuteOnHint(MapExpression.ExecuteOnLocation hint)
                               throws PropertyException,
                                      MappingException

Set all execute on hints for all expression attributes to the specified value.

Parameters:: hint -
Throws:: PropertyException; MappingException

getRowLocatorCandidates

public java.util.List getRowLocatorCandidates()
                                       throws MappingException,
                                              AdapterException

Throws:: MappingException; AdapterException

getRowLocator

public MapAttribute getRowLocator()
                           throws MappingException,
                                  AdapterException

Throws:: MappingException; AdapterException

setRowLocator

public void setRowLocator(MapAttribute rowLocator)
                   throws MappingException,
                          AdapterException

Throws:: MappingException; AdapterException

isIncludeNulls

public boolean isIncludeNulls()
                       throws PropertyException

Throws:: PropertyException

setIncludeNulls

public void setIncludeNulls(boolean includeNulls)
                     throws PropertyException

Throws:: PropertyException

getValueLocators

public java.util.List getValueLocators()
                                throws MappingException,
                                       AdapterException

Throws:: MappingException; AdapterException

getValueLocator

public MapAttribute getValueLocator()
                             throws MappingException,
                                    AdapterException

Throws:: MappingException; AdapterException

getTransformKeys

public java.util.Collection getTransformKeys()
                                      throws MappingException,
                                             AdapterException

Throws:: MappingException; AdapterException

addTransform

public void addTransform(java.lang.String keyExpr,
                         java.lang.String valExpr)
                  throws MappingException,
                         AdapterException

Throws:: MappingException; AdapterException

addTransforms

public void addTransforms(java.lang.String keyExpr,
                          java.util.Map locatorExprs)
                   throws MappingException,
                          AdapterException

Throws:: MappingException; AdapterException

addTransformKey

public Property addTransformKey(java.lang.String keyExpr)
                         throws MappingException,
                                AdapterException

Throws:: MappingException; AdapterException

getTransformExpressions

public java.util.Map getTransformExpressions(Property keyProp)
                                      throws MappingException,
                                             AdapterException

Throws:: MappingException; AdapterException

setTransformExpressions

public void setTransformExpressions(Property keyProp,
                                    java.util.Map vLocatorExprs)
                             throws MappingException,
                                    AdapterException

Throws:: MappingException; AdapterException

removeTransform

public void removeTransform(Property transformKey)
                     throws MappingException,
                            AdapterException

Throws:: MappingException; AdapterException

isValidForTechnology

public boolean isValidForTechnology(ITechnology techno,
                                    java.util.List issues)
                             throws MappingException

Overrides:: isValidForTechnology in class DefaultDelegate
Throws:: MappingException

Class UnpivotComponent

Nested Class Summary

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

Field Summary

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