oracle.rules.sdk2.datamodel
Class AdfBcFactTypeDescriptor

java.lang.Object
  oracle.rules.sdk2.datamodel.AdfBcFactTypeDescriptor

public class AdfBcFactTypeDescriptor
extends java.lang.Object

Utility class to assist with stuffing ADF-BC fact types into RL variables for retrieval at runtime

Nested Class Summary

static class	AdfBcFactTypeDescriptor.Attribute Helper class attribute: struct containing attribute name, type, and linked type (if REFERENCE or AGGR_COLLECTION)
static class	AdfBcFactTypeDescriptor.AttrType Attribute Type: either KEY_ATTRIBUTE (attribute that's a primary key), ATTRIBUTE (other atomic attributes), REFERENCE (an ADF-BC fact in a one-to-one relationship), AGGR_COLLECTION(an ADF-BC fact in a one-to-many relationship) or JBO_ROW_ATTRIBUTE (a pointer to the JBO row object).

Constructor Summary

AdfBcFactTypeDescriptor()

Method Summary

AdfBcFactTypeDescriptor.Attribute	addAttribute()
AdfBcFactTypeDescriptor.Attribute	addAttribute(java.lang.String name, AdfBcFactTypeDescriptor.AttrType type, java.lang.String linkType)
AdfBcFactTypeDescriptor.Attribute	addAttribute(java.lang.String name, java.lang.String type, java.lang.String linkType)
java.lang.String	asString()
java.util.ArrayList<AdfBcFactTypeDescriptor.Attribute>	getAttributes()
java.lang.String	getDataSource()
java.lang.String	getTypeName()
static AdfBcFactTypeDescriptor	load(RuleSession rs, java.lang.String typeName) Load an AdfBcFactTypeDescriptor instance from an RL global session variable.
static AdfBcFactTypeDescriptor	load(java.lang.String dictionaryName, RuleSession rs, java.lang.String typeName)
void	setDataSource(java.lang.String dataSource)
AdfBcFactTypeDescriptor	setTypeName(java.lang.String name)
AdfBcFactTypeDescriptor	write(VariableTable vt) Writes self to the RuleDictionary's variable table.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdfBcFactTypeDescriptor

public AdfBcFactTypeDescriptor()

Method Detail

setDataSource

public void setDataSource(java.lang.String dataSource)

getDataSource

public java.lang.String getDataSource()

getTypeName

public java.lang.String getTypeName()

Returns:

the type name of the ADF-BC fact type

getAttributes

public java.util.ArrayList<AdfBcFactTypeDescriptor.Attribute> getAttributes()

Returns:

list of attributes for this descriptor

addAttribute

public AdfBcFactTypeDescriptor.Attribute addAttribute()

Returns:

a new uninitialized attribute belonging to this descriptor

addAttribute

public AdfBcFactTypeDescriptor.Attribute addAttribute(java.lang.String name,
                                                      java.lang.String type,
                                                      java.lang.String linkType)

Parameters:

name -

type -

linkType -

Returns:

an initialized attribute belonging to this descriptor

addAttribute

public AdfBcFactTypeDescriptor.Attribute addAttribute(java.lang.String name,
                                                      AdfBcFactTypeDescriptor.AttrType type,
                                                      java.lang.String linkType)

Parameters:

name -

type -

linkType -

Returns:

an initialized attribute belonging to this descriptor

setTypeName

public AdfBcFactTypeDescriptor setTypeName(java.lang.String name)

Parameters:

name -

Returns:

self

asString

public java.lang.String asString()

Returns:

String representation of attribute list in semi-colon-separated comma-separated format

write

public AdfBcFactTypeDescriptor write(VariableTable vt)

Writes self to the RuleDictionary's variable table.

Parameters:

vt - VariableTable instance to be written to

Returns:

self

load

public static AdfBcFactTypeDescriptor load(RuleSession rs,
                                           java.lang.String typeName)
                                    throws RLException

Load an AdfBcFactTypeDescriptor instance from an RL global session variable.

Parameters:

rs -

typeName -

Returns:

a descriptor based on the session variable, or null if typeName is undefined.

Throws:

RLException

load

public static AdfBcFactTypeDescriptor load(java.lang.String dictionaryName,
                                           RuleSession rs,
                                           java.lang.String typeName)
                                    throws RLException

Throws:

RLException