org.sapia.regis
Interface RWNode

All Superinterfaces:

Node

All Known Implementing Classes:

NodeImpl

public interface RWNode
extends Node

This insterface extends the Node interface in order to support write operations.

Author:

yduchesne

Field Summary

Fields inherited from interface org.sapia.regis.Node

ROOT_NAME

Method Summary

void	addInclude(Node node)
void	appendLink(Node node)
Node	createChild(String name)
void	deleteChild(String name)
void	deleteChildren() Deletes the child Nodes of this instance.
void	deleteIncludes() Removes all included nodes from this instance.
void	deleteLinks() Removes all linked nodes from this instance.
void	deleteProperties() Deletes this instance's properties.
void	deleteProperty(String key)
void	moveTo(Node newParent) Moves this instance to the given parent.
void	prependLink(Node node)
void	removeAppendedLink(Node node)
void	removeInclude(Node node)
void	removePrependedLink(Node node)
void	setInheritsParent(boolean inheritsParent) Sets the inheritance mode of this instance.
void	setProperty(String key, String value)
void	setType(String type)

Methods inherited from interface org.sapia.regis.Node

getAbsolutePath, getChild, getChild, getChildren, getChildrenNames, getIncludes, getLinks, getName, getNodes, getParent, getProperties, getProperties, getProperty, getPropertyKeys, getType, isInheritsParent, isRoot, lastModifChecksum, renderProperty, renderProperty

Method Detail

setProperty

void setProperty(String key,
                 String value)

Parameters:

key - a property key.

value - a property value.

deleteProperty

void deleteProperty(String key)

Parameters:

key - the key of the property to delete.

deleteProperties

void deleteProperties()

Deletes this instance's properties.

setType

void setType(String type)

Parameters:

type - the type of this node.

See Also:

Form.getType()

createChild

Node createChild(String name)
                 throws DuplicateNodeException

Parameters:

name - the name under which the new child node should be bound under this instance.

Returns:

the newly created Node

Throws:

DuplicateNodeException - if a node already exists under this instance, for the given name.

deleteChild

void deleteChild(String name)

Parameters:

name - deletes the child Node with the given name from this instance.

deleteChildren

void deleteChildren()

Deletes the child Nodes of this instance.

setInheritsParent

void setInheritsParent(boolean inheritsParent)

Sets the inheritance mode of this instance.

Parameters:

inheritsParent - if true, indicates to this instance that it should inherit its parent's configuration properties.

prependLink

void prependLink(Node node)

Parameters:

node - a linked Node.

removePrependedLink

void removePrependedLink(Node node)

Parameters:

node - a linked Node

appendLink

void appendLink(Node node)

Parameters:

node - a linked Node.

removeAppendedLink

void removeAppendedLink(Node node)

Parameters:

node - a linked Node

deleteLinks

void deleteLinks()

Removes all linked nodes from this instance.

addInclude

void addInclude(Node node)

Parameters:

node - a Node to included.

removeInclude

void removeInclude(Node node)

Parameters:

node - a Node to remove from this instance's included nodes.

deleteIncludes

void deleteIncludes()

Removes all included nodes from this instance.

moveTo

void moveTo(Node newParent)

Moves this instance to the given parent.

Parameters:

newParent - a Node.