oracle.jdeveloper.jot
Interface JotNode

public interface JotNode

Method Summary

int	getElementType() Returns this element's type as an integer.
java.lang.String	getID() Returns a string representation of this element as a handle.
JotModel	getJotModel() Returns the JotModel.
JotWorkArea	getJotWorkArea() Retrieves the JotWorkArea which contains this element, or null if no JotWorkArea contains this node.
java.lang.String	getNodeName() Returns the name of this element.
JotElement	getParent() Returns the element directly containing this element, or null if this element has no parent.
boolean	isExistant() Determines whether this JotElement currently exists in the model.
boolean	isReadOnly() Returns whether this JotElement is read-only.
boolean	isStructureKnown() Determines whether or not the contents of this element are knowable.

Method Detail

isExistant

public boolean isExistant()

Determines whether this JotElement currently exists in the model. As elements to not represent the actual elements found in the tree, there may be occasion where a client has maintained an old or invalid element.

Returns:

true if this element exists in the JotModel.

isReadOnly

public boolean isReadOnly()

Returns whether this JotElement is read-only. The Jot only permits elements to be written to if their underlying resource is specifically opened in the environment or contined by the project, or super-project of this element explicitely, and the resource is not also read-only

Returns:

true if this element is read-only.

getNodeName

public java.lang.String getNodeName()

Returns the name of this element.

Returns:

the name of this element.

getElementType

public int getElementType()

Returns this element's type as an integer. The integer corresponds to one of the constants declared in JotElement

Returns:

the type of element;

getID

public java.lang.String getID()

Returns a string representation of this element as a handle. This string identifier is consistent across JDeveloper sessions and can be used to recreate the element, if its corresponding model element still exists in the parent, by calling Jot.create(java.lang.String).

Returns:

the string handle identifier

getParent

public JotElement getParent()

Returns the element directly containing this element, or null if this element has no parent.

Returns:

the parent element, or null if this element has no parent.

getJotWorkArea

public JotWorkArea getJotWorkArea()

Retrieves the JotWorkArea which contains this element, or null if no JotWorkArea contains this node.

Returns:

the JotWorkArea which contains this element, or null if no JotWorkArea contains this element.

getJotModel

public JotModel getJotModel()

Returns the JotModel.

Returns:

the JotModel.

isStructureKnown

public boolean isStructureKnown()
                         throws JotException

Determines whether or not the contents of this element are knowable. If the portion of the resource containing this element cannot be parsed at the moment, then isStructureKnown will return false.

Returns:

true if the structure is known.

Throws:

JotException