oracle.apps.fnd.applseed.rt.extract.common
Class RowKeyBuilder

java.lang.Object
  oracle.apps.fnd.applseed.rt.extract.common.RowKeyBuilder

public class RowKeyBuilder
extends java.lang.Object

This class contains the methods to build row keys for a given View Object and Row. There should be one builder per SDViewNode. Use RowKeyBuilderFactory to get/create instances of RowKeyBuilder.

Field Summary

static char

KEY_DELIM_CHAR key delimiter character.

Constructor Summary

RowKeyBuilder(SDViewNode node)
Constructor for building keys for SDViewNode objects.

RowKeyBuilder(SDViewNode node, oracle.jbo.Row rowP)
Constructor for building keys for one VO and Row.

Method Summary

RowKey	buildEffDateLogicalKey(oracle.jbo.Row rowP) Build a RowKey for an effective dated row, with only the keys that make up the logical row, that is, without the effdate attributes.
RowKey	buildKey() Build a key from this row and vo key attribute list.
RowKey	buildKey(oracle.jbo.Row rowP) Build a key for given Row for this vo key attribute list.
java.lang.String	buildKeyAttribValueString() Helper method to build an output string showing attribute=value pairs for current node and row.
java.lang.String	buildKeyAttribValueString(oracle.jbo.Row rowP) Helper method to build an output string showing attribute=value pairs for current node and given row.
RowKey	buildResolvedKey(oracle.jbo.Row rowP) Build a fully resolved RowKey, containing full parental lineage, dereferencing any surrogates to invariant alternate keys.
static RowKeyBuilder	getBuilder(SDViewNode node) Get the RowKeyBuilder object for the passed node.
java.util.List<oracle.jbo.AttributeDef>	getKeyAttribList() Getter for key attribute list.
SDViewNode	getNode() Get the view node for this builder.
java.util.Collection<java.lang.String>	getResolvedKeyAttribList() Get the collection of full resolved key attributes for the current node and its ancestors.
oracle.jbo.Row	getRow() Getter for current Row.
void	setRow(oracle.jbo.Row rowP) Setter for current row.
java.lang.String	toString() Return a String representation of this builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

KEY_DELIM_CHAR

public static final char KEY_DELIM_CHAR

key delimiter character.

See Also:

Constant Field Values

Constructor Detail

RowKeyBuilder

public RowKeyBuilder(SDViewNode node)

Constructor for building keys for SDViewNode objects. Use the alternate key attributes first, or primary keys if no alt keys.

Parameters:

node - SDViewNode to build keys for

RowKeyBuilder

public RowKeyBuilder(SDViewNode node,
                     oracle.jbo.Row rowP)

Constructor for building keys for one VO and Row.

Parameters:

node - SDViewNode containing key attributes

rowP - Row object contianing key values

Method Detail

setRow

public void setRow(oracle.jbo.Row rowP)

Setter for current row.

Parameters:

rowP - Row object to set

getRow

public oracle.jbo.Row getRow()

Getter for current Row.

Returns:

Row object of current defined row, null if none

getKeyAttribList

public java.util.List<oracle.jbo.AttributeDef> getKeyAttribList()

Getter for key attribute list.

Returns:

AttributeDef List of attribute names that make up this key.

getResolvedKeyAttribList

public java.util.Collection<java.lang.String> getResolvedKeyAttribList()
                                                                throws ExtractException

Get the collection of full resolved key attributes for the current node and its ancestors.

Returns:

collection of key attribute name Strings

Throws:

ExtractException

buildResolvedKey

public RowKey buildResolvedKey(oracle.jbo.Row rowP)
                        throws ExtractException

Build a fully resolved RowKey, containing full parental lineage, dereferencing any surrogates to invariant alternate keys.

Parameters:

rowP - Row

Returns:

RowKey

Throws:

ExtractException - if failure to resolve all keys

getBuilder

public static RowKeyBuilder getBuilder(SDViewNode node)

Get the RowKeyBuilder object for the passed node.

Parameters:

node - SDViewNode

Returns:

RowKeyBuilder object instance associated with the node

buildKey

public RowKey buildKey()

Build a key from this row and vo key attribute list.

Returns:

delimited key string

buildKey

public RowKey buildKey(oracle.jbo.Row rowP)

Build a key for given Row for this vo key attribute list.

Parameters:

rowP - Row object to set

Returns:

RowKey object

buildEffDateLogicalKey

public RowKey buildEffDateLogicalKey(oracle.jbo.Row rowP)

Build a RowKey for an effective dated row, with only the keys that make up the logical row, that is, without the effdate attributes.

Parameters:

rowP -

Returns:

getNode

public SDViewNode getNode()

Get the view node for this builder.

Returns:

SDViewNode

toString

public java.lang.String toString()

Return a String representation of this builder.

Overrides:

toString in class java.lang.Object

Returns:

String key

buildKeyAttribValueString

public java.lang.String buildKeyAttribValueString(oracle.jbo.Row rowP)

Helper method to build an output string showing attribute=value pairs for current node and given row.

Parameters:

rowP - Row definition

Returns:

String in format "[ attribute=value ... ]"

buildKeyAttribValueString

public java.lang.String buildKeyAttribValueString()

Helper method to build an output string showing attribute=value pairs for current node and row.

Returns:

String in format "[ attribute=value ... ]"