com.goldencode.p2j.directory

Class DirNode

java.lang.Object

com.goldencode.p2j.directory.DirNode

Direct Known Subclasses:

RamNode

class DirNode
extends java.lang.Object

This class is used to hold node data - definition, attributes and list of names of child nodes. It also implements most functionality required by simple back-ends which hold data in memory. Derived classes may use existing data members of this class (in particular childList) to store child nodes, not just their names.

Version:

1.0

Author:

SIY

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,Attribute>	attributes Current node attributes
protected java.util.Map<java.lang.String,java.lang.Object>	childList List of child nodes
private java.lang.String	name Node name
protected ObjectClass	nodeClass Object Class represented by node

Constructor Summary

Constructors

Constructor and Description
DirNode(DirNode other) Constructs node as copy of other node.
DirNode(ObjectClass nodeClass, java.lang.String name) Constructs an empty node of given class and name.
DirNode(java.lang.String className, java.lang.String name) Constructs an empty node of given class name and name.

Method Summary

Modifier and Type	Method and Description
(package private) boolean	addAttribute(Attribute attribute) Add attribute to the node.
private void	addAttributeInt(Attribute attribute) Convenience method which adds attribute into the set of node attributes.
(package private) boolean	addAttributeValue(java.lang.String attrName, java.lang.Object value, boolean initial) Add new attribute value.
(package private) boolean	addChild(java.lang.String child) Add a new child node if this is allowed.
(package private) boolean	addStringAttributeValue(java.lang.String attrName, java.lang.String value) Add new attribute value using String as a data source.
(package private) Attribute	genAttribute(java.lang.String attrName) Get existing attribute or generate new empty instance of Attribute.
(package private) Attribute	getAttribute(java.lang.String name) Get an attribute with specified name.
(package private) Attribute[]	getAttributes() Get a list of all attributes.
(package private) int	getChildCount() Get number of children.
(package private) java.lang.String[]	getChildNames() Get a list of all child node names.
(package private) java.lang.String	getName() Get node name.
(package private) ObjectClass	getNodeClass() Get node Object Class.
(package private) boolean	hasChild(java.lang.String name) Check if child node with specified name exists.
(package private) boolean	isA(java.lang.String className) Check if node is of specified Object Class.
(package private) boolean	isLeaf() Check if object class of the node does not allow adding child nodes.
(package private) boolean	isValid() Verify validness of the node.
(package private) boolean	removeAttribute(java.lang.String name) Remove attribute with specified name.
(package private) boolean	removeChild(java.lang.String child) Remove child with specified name.
(package private) boolean	replaceAttributes(Attribute[] attrList) Add array of attributes to the node.
(package private) boolean	setAttribute(Attribute attribute) Add or replace attribute with specified one.
(package private) boolean	setAttributeValue(java.lang.String attrName, java.lang.Object value, int ndx) Set new attribute value.
(package private) void	setName(java.lang.String name) Rename node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

attributes

private java.util.Map<java.lang.String,Attribute> attributes

Current node attributes

childList

protected java.util.Map<java.lang.String,java.lang.Object> childList

List of child nodes

name

private java.lang.String name

Node name

nodeClass

protected ObjectClass nodeClass

Object Class represented by node

Constructor Detail

DirNode

DirNode(ObjectClass nodeClass,
        java.lang.String name)

Constructs an empty node of given class and name. Note that constructed node may be not valid until all mandatory attributes are filled.

Parameters:

nodeClass - Object Class of the created node.

name - Node name.

DirNode

DirNode(java.lang.String className,
        java.lang.String name)

Constructs an empty node of given class name and name. Note that constructed node may be not valid until all mandatory attributes are filled.

Parameters:

className - Object Class name of the created node.

name - Node name.

DirNode

DirNode(DirNode other)

Constructs node as copy of other node.

Parameters:

other - DirNode instance to copy data from.

Method Detail

addAttribute

boolean addAttribute(Attribute attribute)

Add attribute to the node. Replace existing attribute if it exists.

Parameters:

attribute - Attribute instance to add.

Returns:

true if operation was successful.

replaceAttributes

boolean replaceAttributes(Attribute[] attrList)

Add array of attributes to the node. Replace existing if they exists and remove existing attributes if they are not in array.

Parameters:

attrList - List of new node attributes.

Returns:

true if operation was successful.

addAttributeValue

boolean addAttributeValue(java.lang.String attrName,
                          java.lang.Object value,
                          boolean initial)

Add new attribute value.

Parameters:

attrName - Attribute name

value - Attribute value

initial - Allow initialisation of the immutable attributes. true if this is initialisation mode.

Returns:

true if operation was successful.

addChild

boolean addChild(java.lang.String child)

Add a new child node if this is allowed.

Parameters:

child - Child name.

Returns:

true if operation was successful.

addStringAttributeValue

boolean addStringAttributeValue(java.lang.String attrName,
                                java.lang.String value)

Add new attribute value using String as a data source.

Parameters:

attrName - Attribute name

value - Attribute value

Returns:

true if operation was successful.

genAttribute

Attribute genAttribute(java.lang.String attrName)

Get existing attribute or generate new empty instance of Attribute.

Parameters:

attrName - Attribute name.

Returns:

Reference to existing or created attribute instance.

getAttribute

Attribute getAttribute(java.lang.String name)

Get an attribute with specified name.

Parameters:

name - Name of the attribute to return.

Returns:

Reference to attribute is such an attribute exists or null otherwise.

getAttributes

Attribute[] getAttributes()

Get a list of all attributes.

Returns:

An array of all node attributes.

getChildCount

int getChildCount()

Get number of children.

Returns:

Number of child nodes.

getChildNames

java.lang.String[] getChildNames()

Get a list of all child node names.

Returns:

An array of all child names.

getName

java.lang.String getName()

Get node name.

Returns:

Node name.

getNodeClass

ObjectClass getNodeClass()

Get node Object Class.

Returns:

ObjectClass instance assigned to node.

hasChild

boolean hasChild(java.lang.String name)

Check if child node with specified name exists.

Parameters:

name - Child node name.

Returns:

true if child with specified name exists.

isA

boolean isA(java.lang.String className)

Check if node is of specified Object Class.

Parameters:

className - An object class name to compare with.

Returns:

true if node is of specified object class and false otherwise.

isValid

boolean isValid()

Verify validness of the node. Node is considered valid if all mandatory attributes are set.

Returns:

true if node is valid.

removeAttribute

boolean removeAttribute(java.lang.String name)

Remove attribute with specified name.

Parameters:

name - Name of the attribute to remove.

Returns:

true if operation was successful.

setAttribute

boolean setAttribute(Attribute attribute)

Add or replace attribute with specified one.

Parameters:

attribute - An attribute to add or replace existing.

Returns:

true if operation was successful.

setAttributeValue

boolean setAttributeValue(java.lang.String attrName,
                          java.lang.Object value,
                          int ndx)

Set new attribute value.

Parameters:

attrName - Attribute name

value - New value for the attribute

ndx - Index of the value

Returns:

true if operation was successful.

setName

void setName(java.lang.String name)

Rename node.

Parameters:

name - New name for the node.

isLeaf

boolean isLeaf()

Check if object class of the node does not allow adding child nodes.

Returns:

true if object class is leaf.

removeChild

boolean removeChild(java.lang.String child)

Remove child with specified name.

Parameters:

child - Name of the child to remove.

Returns:

true if operation was successful.

addAttributeInt

private void addAttributeInt(Attribute attribute)

Convenience method which adds attribute into the set of node attributes.

Parameters:

attribute - Attribute to add.