org.apache.jackrabbit.mongomk.api.model

Interface Node

All Known Implementing Classes:

NodeImpl

public interface Node

A higher level object representing a node.

Method Summary

Methods

Modifier and Type	Method and Description
void	diff(Node otherNode, org.apache.jackrabbit.mk.model.NodeDiffHandler nodeDiffHandler) Diffs this node with the other node and calls the passed in diff handler.
int	getChildNodeCount() Returns the total number of children of this node.
Iterator<Node>	getChildNodeEntries(int offset, int count) Returns the children iterator for the supplied offset and count.
Node	getChildNodeEntry(String name) Returns the descendant node entry (descendant)
String	getPath() Returns the path of this Node.
Map<String,String>	getProperties() Returns the properties this Node was created with.
Long	getRevisionId() Returns the revision id of this node if known already, else this will return null.

Method Detail

getChildNodeEntry

Node getChildNodeEntry(String name)

Returns the descendant node entry (descendant)

Parameters:

name - Name of the descendant.

Returns:

Descendant node.

getChildNodeCount

int getChildNodeCount()

Returns the total number of children of this node.

This is not necessarily equal to the number of children returned by #getChildren() since this Node might be created with only a subset of children.

Returns:

The total number of children.

getChildNodeEntries

Iterator<Node> getChildNodeEntries(int offset,
                                 int count)

Returns the children iterator for the supplied offset and count.

Parameters:

offset - The offset to return the children from.

count - The number of children to return.

Returns:

Iterator with child entries.

getProperties

Map<String,String> getProperties()

Returns the properties this Node was created with.

Returns:

The properties.

diff

void diff(Node otherNode,
        org.apache.jackrabbit.mk.model.NodeDiffHandler nodeDiffHandler)

Diffs this node with the other node and calls the passed in diff handler.

Parameters:

otherNode - Other node.

nodeDiffHandler - Diff handler.

getPath

String getPath()

Returns the path of this Node.

Returns:

The path.

getRevisionId

Long getRevisionId()

Returns the revision id of this node if known already, else this will return null. The revision id will be determined only after the commit has been successfully performed or the node has been read as part of an existing revision.

Returns:

The revision id of this commit or null.