| java.lang.Object
 com.caucho.jcr.base.BaseItem
com.caucho.jcr.base.BaseNode
All known Subclasses: com.caucho.jcr.file.FileContentNode, com.caucho.jcr.file.DirectoryNode, com.caucho.jcr.file.FileNode,
| BaseNode | | public class BaseNode extends BaseItem implements Node(Code) | | Represents a directory node in the repository.
|
| Method Summary | |
| public void | addMixin(String mixinName)
Adds a mixin type to the node. | | public Node | addNode(String relPath)
Creates a new node given by the relative path. | | public Node | addNode(String relPath, String primaryNodeTypeName)
Creates a new node given by the relative path. | | public boolean | canAddMixin(String mixinName)
Returns true if the given mixin type can be added to the node. | | public void | cancelMerge(Version version)
Cancel a version merge. | | public Version | checkin()
Checks in a new version for to the node. | | public void | checkout()
Checks out a version. | | public void | doneMerge(Version version)
Mark the version merge as complete. | | public Version | getBaseVersion()
Returns the base version. | | public String | getCorrespondingNodePath(String workspaceName)
Returns the node path to a workspace. | | public NodeDefinition | getDefinition()
Returns a description of the node. | | public int | getIndex()
| | public Lock | getLock()
Returns the current lock. | | public NodeType[] | getMixinNodeTypes()
Returns any mixin types for the node. | | public Node | getNode(String relPath)
Returns the node with the given relative path. | | public NodeIterator | getNodes()
Returns the direct child nodes. | | public NodeIterator | getNodes(String namePattern)
Returns the child nodes matching the name pattern. | | public Item | getPrimaryItem()
Returns the node's primary item. | | public NodeType | getPrimaryNodeType()
Returns the node's primary type. | | public PropertyIterator | getProperties()
Returns the an iterator of the properties of the node. | | public PropertyIterator | getProperties(String namePattern)
Returns the an iterator of the properties of the node matching
the pattern. | | public Property | getProperty(String relPath)
Returns the property based on the relative path. | | public PropertyIterator | getReferences()
| | public String | getUUID()
| | public VersionHistory | getVersionHistory()
Returns the node's version history. | | public boolean | hasNode(String relPath)
Returns true if the path points to a node. | | public boolean | hasNodes()
Returns true if the node has child nodes. | | public boolean | hasProperties()
Returns true if the node has any properties. | | public boolean | hasProperty(String relPath)
Returns true if the path points to a property. | | public boolean | holdsLock()
Returns true if the node owns a lock. | | public boolean | isCheckedOut()
Returns true for a checked out node. | | public boolean | isLocked()
Returns true if the node is locked. | | public boolean | isNode()
Returns true for a node. | | public boolean | isNodeType(String nodeTypeName)
Returns true if the node supports the given node type. | | public Lock | lock(boolean isDeep, boolean isSessionScoped)
Lock the node. | | public NodeIterator | merge(String srcWorkspace, boolean bestEffort)
Merges child nodes. | | public void | orderBefore(String srcChildRelPath, String destChildRelPath)
| | public void | removeMixin(String mixinName)
Removes a mixin type to the node. | | public void | restore(String versionName, boolean removeExisting)
Restore the node based on an older version. | | public void | restore(Version version, boolean removeExisting)
Restore the node based on an older version. | | public void | restore(Version version, String relPath, boolean removeExisting)
Restore the node based on an older version. | | public void | restoreByLabel(String versionLabel, boolean removeExisting)
Restore the node based on an older version. | | public Property | setProperty(String name, Value value)
Sets a property of the node. | | public Property | setProperty(String name, Value value, int type)
Sets a property of the node. | | public Property | setProperty(String name, Value[] values)
Sets a property of the node with a value array. | | public Property | setProperty(String name, Value[] values, int type)
Sets a property of the node with a value array. | | public Property | setProperty(String name, String[] values)
| | public Property | setProperty(String name, String[] values, int type)
| | public Property | setProperty(String name, String value)
| | public Property | setProperty(String name, String value, int type)
| | public Property | setProperty(String name, InputStream value)
| | public Property | setProperty(String name, boolean value)
| | public Property | setProperty(String name, double value)
| | public Property | setProperty(String name, long value)
| | public Property | setProperty(String name, Calendar value)
| | public Property | setProperty(String name, Node value)
| | public void | unlock()
Unlocks the node. | | public void | update(String srcWorkspaceName)
|
| addMixin | | public void addMixin(String mixinName) throws NoSuchNodeTypeException, VersionException, ConstraintViolationException, LockException, RepositoryException(Code) | | Adds a mixin type to the node.
|
| addNode | | public Node addNode(String relPath) throws ItemExistsException, PathNotFoundException, VersionException, ConstraintViolationException, LockException, RepositoryException(Code) | | Creates a new node given by the relative path.
Parameters:
relPath - relative path to the new node. |
| addNode | | public Node addNode(String relPath, String primaryNodeTypeName) throws ItemExistsException, PathNotFoundException, NoSuchNodeTypeException, LockException, VersionException, ConstraintViolationException, RepositoryException(Code) | | Creates a new node given by the relative path.
Parameters:
relPath - relative path to the new node.
Parameters:
primaryNodeTypeName - the node type of the new node |
| canAddMixin | | public boolean canAddMixin(String mixinName) throws NoSuchNodeTypeException, RepositoryException(Code) | | Returns true if the given mixin type can be added to the node.
|
| cancelMerge | | public void cancelMerge(Version version) throws VersionException, InvalidItemStateException, UnsupportedRepositoryOperationException, RepositoryException(Code) | | Cancel a version merge.
|
| checkin | | public Version checkin() throws VersionException, UnsupportedRepositoryOperationException, InvalidItemStateException, LockException, RepositoryException(Code) | | Checks in a new version for to the node.
|
| checkout | | public void checkout() throws UnsupportedRepositoryOperationException, LockException, RepositoryException(Code) | | Checks out a version.
|
| doneMerge | | public void doneMerge(Version version) throws VersionException, InvalidItemStateException, UnsupportedRepositoryOperationException, RepositoryException(Code) | | Mark the version merge as complete.
|
| getBaseVersion | | public Version getBaseVersion() throws UnsupportedRepositoryOperationException, RepositoryException(Code) | | Returns the base version.
|
| getCorrespondingNodePath | | public String getCorrespondingNodePath(String workspaceName) throws ItemNotFoundException, NoSuchWorkspaceException, AccessDeniedException, RepositoryException(Code) | | Returns the node path to a workspace.
|
| getDefinition | | public NodeDefinition getDefinition() throws RepositoryException(Code) | | Returns a description of the node.
|
| getIndex | | public int getIndex() throws RepositoryException(Code) | | Returns the node's index
|
| getLock | | public Lock getLock() throws UnsupportedRepositoryOperationException, LockException, AccessDeniedException, RepositoryException(Code) | | Returns the current lock.
|
| getMixinNodeTypes | | public NodeType[] getMixinNodeTypes() throws RepositoryException(Code) | | Returns any mixin types for the node.
|
| getNode | | public Node getNode(String relPath) throws PathNotFoundException, RepositoryException(Code) | | Returns the node with the given relative path.
Parameters:
name - relPath path to the given ndoe. |
| getNodes | | public NodeIterator getNodes() throws RepositoryException(Code) | | Returns the direct child nodes.
|
| getNodes | | public NodeIterator getNodes(String namePattern) throws RepositoryException(Code) | | Returns the child nodes matching the name pattern.
|
| getPrimaryItem | | public Item getPrimaryItem() throws ItemNotFoundException, RepositoryException(Code) | | Returns the node's primary item.
|
| getPrimaryNodeType | | public NodeType getPrimaryNodeType() throws RepositoryException(Code) | | Returns the node's primary type.
|
| getProperties | | public PropertyIterator getProperties() throws RepositoryException(Code) | | Returns the an iterator of the properties of the node.
|
| getProperties | | public PropertyIterator getProperties(String namePattern) throws RepositoryException(Code) | | Returns the an iterator of the properties of the node matching
the pattern.
|
| getProperty | | public Property getProperty(String relPath) throws PathNotFoundException, RepositoryException(Code) | | Returns the property based on the relative path.
|
| getReferences | | public PropertyIterator getReferences() throws RepositoryException(Code) | | Returns the an iterator of the references
|
| getUUID | | public String getUUID() throws UnsupportedRepositoryOperationException, RepositoryException(Code) | | Returns the node's UUID
|
| getVersionHistory | | public VersionHistory getVersionHistory() throws UnsupportedRepositoryOperationException, RepositoryException(Code) | | Returns the node's version history.
|
| hasNode | | public boolean hasNode(String relPath) throws RepositoryException(Code) | | Returns true if the path points to a node.
Parameters:
relPath - path to a property |
| hasNodes | | public boolean hasNodes() throws RepositoryException(Code) | | Returns true if the node has child nodes.
|
| hasProperties | | public boolean hasProperties() throws RepositoryException(Code) | | Returns true if the node has any properties.
|
| hasProperty | | public boolean hasProperty(String relPath) throws RepositoryException(Code) | | Returns true if the path points to a property.
Parameters:
relPath - path to a property |
| holdsLock | | public boolean holdsLock() throws RepositoryException(Code) | | Returns true if the node owns a lock.
|
| isCheckedOut | | public boolean isCheckedOut() throws RepositoryException(Code) | | Returns true for a checked out node.
|
| isLocked | | public boolean isLocked() throws RepositoryException(Code) | | Returns true if the node is locked.
|
| isNode | | public boolean isNode()(Code) | | Returns true for a node.
|
| isNodeType | | public boolean isNodeType(String nodeTypeName) throws RepositoryException(Code) | | Returns true if the node supports the given node type.
|
| lock | | public Lock lock(boolean isDeep, boolean isSessionScoped) throws UnsupportedRepositoryOperationException, LockException, AccessDeniedException, InvalidItemStateException, RepositoryException(Code) | | Lock the node.
|
| merge | | public NodeIterator merge(String srcWorkspace, boolean bestEffort) throws NoSuchWorkspaceException, AccessDeniedException, MergeException, LockException, InvalidItemStateException, RepositoryException(Code) | | Merges child nodes.
|
| orderBefore | | public void orderBefore(String srcChildRelPath, String destChildRelPath) throws UnsupportedRepositoryOperationException, VersionException, ConstraintViolationException, ItemNotFoundException, LockException, RepositoryException(Code) | | Moves the source node before the dest
Parameters:
srcChildRelPath - relative path to the source item
Parameters:
destChildRelPath - relative path to the destination item |
| removeMixin | | public void removeMixin(String mixinName) throws NoSuchNodeTypeException, VersionException, ConstraintViolationException, LockException, RepositoryException(Code) | | Removes a mixin type to the node.
|
| restore | | public void restore(String versionName, boolean removeExisting) throws VersionException, ItemExistsException, UnsupportedRepositoryOperationException, LockException, InvalidItemStateException, RepositoryException(Code) | | Restore the node based on an older version.
|
| restore | | public void restore(Version version, boolean removeExisting) throws VersionException, ItemExistsException, UnsupportedRepositoryOperationException, LockException, RepositoryException(Code) | | Restore the node based on an older version.
|
| restore | | public void restore(Version version, String relPath, boolean removeExisting) throws PathNotFoundException, ItemExistsException, VersionException, ConstraintViolationException, UnsupportedRepositoryOperationException, LockException, InvalidItemStateException, RepositoryException(Code) | | Restore the node based on an older version.
|
| restoreByLabel | | public void restoreByLabel(String versionLabel, boolean removeExisting) throws VersionException, ItemExistsException, UnsupportedRepositoryOperationException, LockException, InvalidItemStateException, RepositoryException(Code) | | Restore the node based on an older version.
|
| setProperty | | public Property setProperty(String name, Value value) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node.
Parameters:
name - single-level name identifying the property
Parameters:
value - the property's new value |
| setProperty | | public Property setProperty(String name, Value value, int type) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node.
Parameters:
name - single-level name identifying the property
Parameters:
value - the property's new value
Parameters:
type - the property's value type |
| setProperty | | public Property setProperty(String name, Value[] values) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node with a value array.
Parameters:
name - single-level name identifying the property
Parameters:
values - array of values for the property |
| setProperty | | public Property setProperty(String name, Value[] values, int type) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node with a value array.
Parameters:
name - single-level name identifying the property
Parameters:
values - array of values for the property
Parameters:
type - the expected type of the property |
| setProperty | | public Property setProperty(String name, String[] values) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node with an array of string values
Parameters:
name - single-level name identifying the property
Parameters:
values - array of values for the property |
| setProperty | | public Property setProperty(String name, String[] values, int type) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node with an array of string values
Parameters:
name - single-level name identifying the property
Parameters:
values - array of values for the property
Parameters:
type - the expected type of the property |
| setProperty | | public Property setProperty(String name, String value) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node with a single string value
Parameters:
name - single-level name identifying the property
Parameters:
values - array of values for the property
Parameters:
type - the expected type of the property |
| setProperty | | public Property setProperty(String name, String value, int type) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node with a single string value
Parameters:
name - single-level name identifying the property
Parameters:
values - array of values for the property
Parameters:
type - the expected type of the property |
| setProperty | | public Property setProperty(String name, InputStream value) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node from an input stream
Parameters:
name - single-level name identifying the property
Parameters:
value - input stream containing the data |
| setProperty | | public Property setProperty(String name, boolean value) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node from a boolean
Parameters:
name - single-level name identifying the property
Parameters:
value - boolean data |
| setProperty | | public Property setProperty(String name, double value) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node from a double
Parameters:
name - single-level name identifying the property
Parameters:
value - double data |
| setProperty | | public Property setProperty(String name, long value) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node from a long
Parameters:
name - single-level name identifying the property
Parameters:
value - long data |
| setProperty | | public Property setProperty(String name, Calendar value) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node from a date
Parameters:
name - single-level name identifying the property
Parameters:
value - calendar data |
| setProperty | | public Property setProperty(String name, Node value) throws ValueFormatException, VersionException, LockException, ConstraintViolationException, RepositoryException(Code) | | Sets a property of the node from a based on a reference to a node
Parameters:
name - single-level name identifying the property
Parameters:
value - node reference |
| unlock | | public void unlock() throws UnsupportedRepositoryOperationException, LockException, AccessDeniedException, InvalidItemStateException, RepositoryException(Code) | | Unlocks the node.
|
| update | | public void update(String srcWorkspaceName) throws NoSuchWorkspaceException, AccessDeniedException, LockException, InvalidItemStateException, RepositoryException(Code) | | Updates a workspace
|
| Methods inherited from com.caucho.jcr.base.BaseItem | public void accept(ItemVisitor visitor) throws RepositoryException(Code)(Java Doc)
public Item getAncestor(int depth) throws ItemNotFoundException, AccessDeniedException, RepositoryException(Code)(Java Doc)
public int getDepth() throws RepositoryException(Code)(Java Doc)
public String getName() throws RepositoryException(Code)(Java Doc)
public Node getParent() throws ItemNotFoundException, AccessDeniedException, RepositoryException(Code)(Java Doc)
public String getPath() throws RepositoryException(Code)(Java Doc)
public Session getSession() throws RepositoryException(Code)(Java Doc)
public boolean isModified()(Code)(Java Doc)
public boolean isNew()(Code)(Java Doc)
public boolean isNode()(Code)(Java Doc)
public boolean isSame(Item otherItem) throws RepositoryException(Code)(Java Doc)
public void refresh(boolean keepChanges) throws InvalidItemStateException, RepositoryException(Code)(Java Doc)
public void remove() throws VersionException, LockException, ConstraintViolationException, RepositoryException(Code)(Java Doc)
public void save() throws AccessDeniedException, ItemExistsException, ConstraintViolationException, InvalidItemStateException, ReferentialIntegrityException, VersionException, LockException, NoSuchNodeTypeException, RepositoryException(Code)(Java Doc)
|
|
|