oracle.rules.sdk2.datamodel

Class Node

java.lang.Object

oracle.rules.sdk2.datamodel.Node

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.String>

Direct Known Subclasses:

JavaNode

public abstract class Node
extends java.lang.Object
implements java.util.Map<java.lang.String,java.lang.String>

An abstract class that represents Nodes in a schema or class hierarchy.
Sub-classes are used to load Java or Jaxb classes into the DataModel.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLOSED
static java.lang.String	FALSE
static java.lang.String	OPEN
static java.lang.String	PROP_LOAD_FLAG
static java.lang.String	PROP_NAME
static java.lang.String	PROP_STATE
static java.lang.String	TRUE

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all of the mappings from this map (optional operation).
void	close() Mark this node as "closed".
boolean	containsKey(java.lang.Object key) Returns true if this map contains a mapping for the specified key.
boolean	containsValue(java.lang.Object value) Returns true if this map maps one or more keys to the specified value.
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	entrySet() Returns a Set view of the mappings contained in this map.
boolean	equals(java.lang.Object o) Indicates whether some other object is "equal to" this one.
java.lang.String	get(java.lang.Object key) Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
RuleDictionary	getDictionary() Return the dictionary that was used to establish the node tree of which this is part.
java.lang.String	getLoadFlag() Return a String represntation of a boolean "true" -- loaded into data model "false" -- not loaded into datamodel
java.lang.String	getName() Return the name property for the node
NodeTable	getNestedTable() Create a NodeTable containing all the immediate children of this Node.
java.lang.String	getOpenState() Return the String representation of state.
NodeTable	getParent() Return the parent for this node
int	hashCode() Returns a hash code value for the object.
boolean	isEmpty() Returns true if this map contains no key-value mappings.
boolean	isOpen() Indicate the status of of a node.
java.util.Set<java.lang.String>	keySet() Returns a Set view of the keys contained in this map.
abstract java.util.List<FactType>	load()
void	open() Mark this node as "opened".
java.lang.String	put(java.lang.String key, java.lang.String value) Associates the specified value with the specified key in this map (optional operation).
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> m) Copies all of the mappings from the specified map to this map (optional operation).
java.lang.String	remove(java.lang.Object key) Removes the mapping for a key from this map if it is present (optional operation).
void	setName(java.lang.String name) Set the name of the Node.
int	size() Returns the number of key-value mappings in this map.
java.util.Collection<java.lang.String>	values() Returns a Collection view of the values contained in this map.

Methods inherited from class java.lang.Object

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

Field Detail

PROP_STATE

public static final java.lang.String PROP_STATE

See Also:

Constant Field Values

OPEN

public static final java.lang.String OPEN

See Also:

Constant Field Values

CLOSED

public static final java.lang.String CLOSED

See Also:

Constant Field Values

PROP_LOAD_FLAG

public static final java.lang.String PROP_LOAD_FLAG

See Also:

Constant Field Values

TRUE

public static final java.lang.String TRUE

See Also:

Constant Field Values

FALSE

public static final java.lang.String FALSE

See Also:

Constant Field Values

PROP_NAME

public static final java.lang.String PROP_NAME

See Also:

Constant Field Values

Method Detail

clear

public void clear()

Description copied from interface: java.util.Map

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.String>

containsKey

public boolean containsKey(java.lang.Object key)

Description copied from interface: java.util.Map

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that (key==null ? k==null : key.equals(k)). (There can be at most one such mapping.)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.String>

Parameters:

key - key whose presence in this map is to be tested

Returns:

true if this map contains a mapping for the specified key

containsValue

public boolean containsValue(java.lang.Object value)

Description copied from interface: java.util.Map

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require time linear in the map size for most implementations of the Map interface.

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.String>

Parameters:

value - value whose presence in this map is to be tested

Returns:

true if this map maps one or more keys to the specified value

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> entrySet()

Description copied from interface: java.util.Map

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.String>

Returns:

a set view of the mappings contained in this map

equals

public boolean equals(java.lang.Object o)

Description copied from class: java.lang.Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Specified by:

equals in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

equals in class java.lang.Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

get

public java.lang.String get(java.lang.Object key)

Description copied from interface: java.util.Map

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.String>

Parameters:

key - the key whose associated value is to be returned

Returns:

the value to which the specified key is mapped, or null if this map contains no mapping for the key

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)

Specified by:

hashCode in interface java.util.Map<java.lang.String,java.lang.String>

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

isEmpty

public boolean isEmpty()

Description copied from interface: java.util.Map

Returns true if this map contains no key-value mappings.

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.String>

Returns:

true if this map contains no key-value mappings

keySet

public java.util.Set<java.lang.String> keySet()

Description copied from interface: java.util.Map

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.String>

Returns:

a set view of the keys contained in this map

put

public java.lang.String put(java.lang.String key,
                   java.lang.String value)

Description copied from interface: java.util.Map

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.String>

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> m)

Description copied from interface: java.util.Map

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.String>

Parameters:

m - mappings to be stored in this map

remove

public java.lang.String remove(java.lang.Object key)

Description copied from interface: java.util.Map

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that (key==null ? k==null : key.equals(k)), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.String>

Parameters:

key - key whose mapping is to be removed from the map

Returns:

the previous value associated with key, or null if there was no mapping for key.

size

public int size()

Description copied from interface: java.util.Map

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.String>

Returns:

the number of key-value mappings in this map

values

public java.util.Collection<java.lang.String> values()

Description copied from interface: java.util.Map

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.String>

Returns:

a collection view of the values contained in this map

setName

public void setName(java.lang.String name)

Set the name of the Node. Used by any reference

Parameters:

name - String with the new name

getName

public java.lang.String getName()

Return the name property for the node

getParent

public NodeTable getParent()

Return the parent for this node

getDictionary

public RuleDictionary getDictionary()

Return the dictionary that was used to establish the node tree of which this is part.

open

public void open()

Mark this node as "opened". The node's state actually has no effect on the behavior of the node. The state of the node is a mneumonic that allows users of Node classes to keep some display state. A nested node table is not created ("opened") until the nested node table is actually retrieved.

close

public void close()

Mark this node as "closed". The node's state actually has no effect on the behavior of the node. The state of the node is a mneumonic that allows callers of nodes to maintian display state. A nested node tables are only created on-demand and have no relationship to the state of the node.

isOpen

public boolean isOpen()

Indicate the status of of a node. Returning true from this node implies that if the node represents a package that the immediate children of this package have been opened (have been materialized in the Node's NestedNodeTable).
If the Node is a class (therefore has no children) then this method will always return true.

Returns:

boolean indcating node open or closed

getOpenState

public java.lang.String getOpenState()

Return the String representation of state. Node.OPEN and Node.CLOSED returned depending on whether the children of the node are displayed. If isOpen() returns true, this method will return Node.OPEN if isOpen() returns false, this method will return Node.CLOSED

Returns:

String from one of Node.CLOSED or Node.OPEN

getNestedTable

public NodeTable getNestedTable()

Create a NodeTable containing all the immediate children of this Node. If this Node can not have any children (e.g. JClassNode or JaxbNode) then this will return null.

Returns:

NodeTable containing all immediate children

load

public abstract java.util.List<FactType> load()

getLoadFlag

public java.lang.String getLoadFlag()

Return a String represntation of a boolean

 "true"   -- loaded into data model
 "false"  -- not loaded into datamodel
 

Returns:

String representing boolean indicating that node is loaded into the DataModel.