com.sri.emo.dbobj.model_tree
Class NodeCompletionStatus

java.lang.Object
  com.sri.emo.dbobj.model_tree.NodeCompletionStatus

All Implemented Interfaces:

Serializable

public final class NodeCompletionStatus
extends Object
implements Serializable

Object represents a recursive/truncation/completion status inside the model. If it is recursive you construt a ModelTruncationStatus() object pointing to the recursive node. Otherwise you use either COMPLETE_NODE or TRUNCATED_NODE to set the completion status.

Author:

Michael Rimov

See Also:

Serialized Form

Field Summary

static NodeCompletionStatus	COMPLETE_NODE Instance representing a complete node.
static NodeCompletionStatus	TRUNCATED_NODE Instance representing a truncated node.
static NodeCompletionStatus	UNDEFINED_STATUS Instance representing an undefined status.

Constructor Summary

NodeCompletionStatus(ModelNode recursiveModelNode)
Constructs a recursive model status node.

Method Summary

boolean	equals(Object obj) Model Recursion status objects are equal if they are the same status type and if they are, they point to the same recursive node.
ModelNode	getRecursiveNode() Retrieves the recursive node that is located elsewhere inside the model tree.
int	hashCode()
boolean	isRecursive() Returns true if this is a recursive node.
boolean	isTruncated() Returns true if this is a truncated node.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

COMPLETE_NODE

public static final NodeCompletionStatus COMPLETE_NODE

Instance representing a complete node.

TRUNCATED_NODE

public static final NodeCompletionStatus TRUNCATED_NODE

Instance representing a truncated node.

UNDEFINED_STATUS

public static final NodeCompletionStatus UNDEFINED_STATUS

Instance representing an undefined status. This is often the case because many nodes in the tree have no concept of truncation depending on the implementation of the factory. For clarification, in DefaultModelFactory only Emo 'Nodes' have the concept of truncation -- actual parts of a node are never truncated

Constructor Detail

NodeCompletionStatus

public NodeCompletionStatus(ModelNode recursiveModelNode)

Constructs a recursive model status node.

Parameters:

recursiveModelNode - ModelNode

Method Detail

getRecursiveNode

public ModelNode getRecursiveNode()

Retrieves the recursive node that is located elsewhere inside the model tree.

Returns:

ModelNode

isRecursive

public boolean isRecursive()

Returns true if this is a recursive node.

Returns:

boolean true if recursive.

isTruncated

public boolean isTruncated()

Returns true if this is a truncated node.

Returns:

boolean true if truncated.

equals

public boolean equals(Object obj)

Model Recursion status objects are equal if they are the same status type and if they are, they point to the same recursive node.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

toString

public String toString()

Overrides:

toString in class Object

Returns:

a string representation of the object.