Skip navigation links

oracle.rules.sdk2.dictionary
Class DictionaryObject

java.lang.Object
oracle.rules.sdk2.dictionary.DictionaryObject

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

DictionaryComponent, DictionaryComponentTable, IDTable

public abstract class DictionaryObject

extends java.lang.Object

implements java.lang.Cloneable, java.io.Serializable

Base class for a RuleDictionary and its components and component tables.

See Also:

Serialized Form

Method Summary

boolean	equals(java.lang.Object o) Handles for the same DictionaryObject are equal.
boolean	exists() obj.exists() means you can reach obj if you start with the dictionary and recursively explore all references.
abstract java.util.List<DOID>	getAEReferences() Get DOIDs referenced by this Object and descendants.
abstract java.util.List<DOID>	getAllReferences() Get all DOIDs referenced by this Object and descendants.
CombinedDataModel	getCombinedDataModel() get the combined data model from containing dictionary and linked dictionaries
java.util.Set<DOID>	getContainedIDs() Get the ID of this object and all objects that it contains, recursively.
java.util.Set<DOID>	getContainedIDs(java.util.Set<DOID> addedIDs)
DataModel	getDataModel() Get the data model for the containing dictionary
RuleDictionary	getDictionary() Get the dictionary that contains this component.
DOID	getID() Get dictionary object ID.
java.lang.String	getIndent()
int	getLevel()
java.lang.String	getObjectPath() get the localized path to this object starting with the dictionary, e.g.
java.lang.String	getObjectType() get the localized name of the type of this dictionary object.
DictionaryObject	getParentByClass(java.lang.Class pclass) search the parent chain for an object that correspondes to specified type.
DictionaryComponent	getParentComponent() get parent dictionary component
DictionaryComponentTable	getParentComponentTable() get parent dictionary component table
DictionaryObject	getParentObject() Get the immediate parent object
java.util.List<DOID>	getReferences() Get all DOIDs referenced by this Component and IDTable properties, but does not include contained dictonary components.
RuleSet	getRuleSet() Get the RuleSet containing this dictionary object.
int	getState()
java.util.List<SDKWarning>	getWarnings(boolean includeDescendants) get Warnings associated with this dictionary object or its descendants.
int	hashCode() Handles for the same DictionaryObject have the same hash code
boolean	isModified()
abstract void	validate(java.util.List<SDKException> errors, java.util.List<SDKWarning> warnings) Validate the entire dictionary object and its decendants.
void	validate(java.util.List<SDKException> errors, java.util.List<SDKWarning> warnings, int modelChangeLowerBound) Deprecated. Use DictionaryObject.validate(List,List)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

equals

public boolean equals(java.lang.Object o)

Handles for the same DictionaryObject are equal.

Overrides:

equals in class java.lang.Object

Parameters:

o - object to test for equality

Returns:

true if o is a handle for the same DictionaryObject as this

hashCode

public int hashCode()

Handles for the same DictionaryObject have the same hash code

Overrides:

hashCode in class java.lang.Object

Returns:

hash code

getAEReferences

public abstract java.util.List<DOID> getAEReferences()

Get DOIDs referenced by this Object and descendants. By convention, properties of type DOID and DOID[] are not considered. This basically makes this useful for finding DOIDs referenced in IDTables and in Expressions and Actions. Note that a parent contains its children but (usually) does not reference them.

Returns:

list of the DOIDS

getAllReferences

public abstract java.util.List<DOID> getAllReferences()

Get all DOIDs referenced by this Object and descendants.

Returns:

list of the DOIDS

getReferences

public java.util.List<DOID> getReferences()

Get all DOIDs referenced by this Component and IDTable properties, but does not include contained dictonary components.

Returns:

list of the DOIDS

getParentObject

public DictionaryObject getParentObject()

Get the immediate parent object

Returns:

immediate DictionaryObject parent

getID

public DOID getID()

Get dictionary object ID. An ID is an identifier for the object. It is invariant across transactions. For components the ID is persistent and thus invariant across saves/loads from disk. For component tables, the ID is not persistent.

Returns:

ID String

exists

public final boolean exists()

obj.exists() means you can reach obj if you start with the dictionary and recursively explore all references. The RuleDictionary.update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) method actually updates a cache that exists uses to make it fast.

Returns:

false if this object no longer exists in the dictionary as of the last update.

getDictionary

public final RuleDictionary getDictionary()

Get the dictionary that contains this component.

Returns:

containing RuleDictionary

getParentByClass

public DictionaryObject getParentByClass(java.lang.Class pclass)

search the parent chain for an object that correspondes to specified type.

getDataModel

public DataModel getDataModel()

Get the data model for the containing dictionary

Returns:

DataModel

getCombinedDataModel

public CombinedDataModel getCombinedDataModel()

get the combined data model from containing dictionary and linked dictionaries

Returns:

CombinedDataModel

getRuleSet

public RuleSet getRuleSet()

Get the RuleSet containing this dictionary object.

Returns:

containing RuleSet or null if this is not in a RuleSet or is not a RuleSet

validate

@Deprecated
public void validate(java.util.List<SDKException> errors,
                                java.util.List<SDKWarning> warnings,
                                int modelChangeLowerBound)

Deprecated. Use DictionaryObject.validate(List,List)

validate

public abstract void validate(java.util.List<SDKException> errors,
                              java.util.List<SDKWarning> warnings)

Validate the entire dictionary object and its decendants. Not incremental.

Parameters:

errors - a List of error exceptions to append to.

warnings - a List of warning exceptions to append to.

See Also:

DictionaryObject.validate(List,List,int,int)

getParentComponent

public DictionaryComponent getParentComponent()

get parent dictionary component

Returns:

DictionaryComponent parent

getParentComponentTable

public DictionaryComponentTable getParentComponentTable()

get parent dictionary component table

Returns:

DictionaryComponentTable parent

getObjectType

public java.lang.String getObjectType()

get the localized name of the type of this dictionary object.

Returns:

the name of the dictionary object (e.g. Variable, Rules, etc.)

getObjectPath

public java.lang.String getObjectPath()

get the localized path to this object starting with the dictionary, e.g. Dictionary(myDic)/Rule Set(rs1)/Decision Table(myDT)

Returns:

localized path to this object

getContainedIDs

public java.util.Set<DOID> getContainedIDs()

Get the ID of this object and all objects that it contains, recursively.

Returns:

set of ID strings

getContainedIDs

public java.util.Set<DOID> getContainedIDs(java.util.Set<DOID> addedIDs)

getWarnings

public java.util.List<SDKWarning> getWarnings(boolean includeDescendants)

get Warnings associated with this dictionary object or its descendants. Note that no validation is performed. Only a subset of warnings from the last RuleDictionary.update(java.util.List<oracle.rules.sdk2.exception.SDKWarning>) are returned.

Parameters:

includeDescendants - whether to include warnings bound to this object's descendants.

Returns:

list of warnings

getLevel

public int getLevel()

getIndent

public java.lang.String getIndent()

isModified

public boolean isModified()

getState

public int getState()

Skip navigation links