org.mmbase.bridge
Interface Node

All Known Subinterfaces:

Relation

All Known Implementing Classes:

BasicNode

public interface Node

Describes an object in the cloud.

Author:

Rob Vermeulen, Pierre van Rooden

Method Summary

void	cancel() Cancel changes to a node This fails if the current node is not in edit mode.
void	commit() Commit the node to the database.
int	countRelatedNodes(java.lang.String type) Returns the number of related nodes that have a specific node manager.
int	countRelations() Returns the number of relations this node has with other nodes.
int	countRelations(java.lang.String relationManager) Returns the number of relation nodes attached to this node that have a specific relation manager.
void	createAlias(java.lang.String alias) Create an alias for this node.
Relation	createRelation(Node destinationNode, RelationManager relationManager) Adds a relation between this node and a specified node to the cloud.
void	delete() Removes the Node.
void	delete(boolean deleteRelations) Removes the Node.
void	deleteAlias(java.lang.String alias) Delete an alias for this node.
void	deleteRelations() Removes all relation nodes attached to this node.
void	deleteRelations(java.lang.String relationManager) Removes all relation nodes with a certain relation manager that are attached to this node.
java.util.List	getAliases() Returns all aliases for this node.
boolean	getBooleanValue(java.lang.String fieldname) Returns the value of the specified field as a boolean.
byte[]	getByteValue(java.lang.String fieldname) Returns the value of the specified field as a byte array.
Cloud	getCloud() Returns the cloud this node belongs to.
java.lang.String	getContext() get the Context of the current Node
double	getDoubleValue(java.lang.String fieldname) Returns the value of the specified field as a double.
float	getFloatValue(java.lang.String fieldname) Returns the value of the specified field as a float.
int	getIntValue(java.lang.String fieldname) Returns the value of the specified field as an int.
long	getLongValue(java.lang.String fieldname) Returns the value of the specified field as a long.
NodeManager	getNodeManager() Returns the node manager for this node.
Node	getNodeValue(java.lang.String fieldname) Returns the value of the specified field as a Node.
int	getNumber() Returns the unique number for this node.
StringList	getPossibleContexts() get the Contextes which can be set to this specific node
NodeList	getRelatedNodes() Returns all related nodes.
NodeList	getRelatedNodes(java.lang.String nodeManager) Returns all related nodes that have a specific node manager.
RelationList	getRelations() Returns all relation nodes attached to this node.
RelationList	getRelations(java.lang.String relationManager) Returns all relation nodes attached to this node that have a specific relation manager.
java.lang.String	getStringValue(java.lang.String fieldname) Returns the value of the specified field as a String.
java.lang.Object	getValue(java.lang.String fieldname) Returns the value of the specified field as an object.
boolean	hasRelations() Checks whether this node has any relations.
boolean	mayChangeContext() Check context-change rights on this node.
boolean	mayDelete() Check delete rights on this node.
boolean	mayLink() Check link rights on this node.
boolean	mayWrite() Check write rights on this node.
void	setByteValue(java.lang.String fieldname, byte[] value) Sets the value of the specified field using a byte array.
void	setContext(java.lang.String context) set the Context of the current Node
void	setDoubleValue(java.lang.String fieldname, double value) Sets the value of the specified field using a double.
void	setFloatValue(java.lang.String fieldname, float value) Sets the value of the specified field using a float.
void	setIntValue(java.lang.String fieldname, int value) Sets the value of the specified field using an int.
void	setLongValue(java.lang.String fieldname, long value) Sets the value of the specified field using a long.
void	setStringValue(java.lang.String fieldname, java.lang.String value) Sets the value of the specified field using a String.
void	setValue(java.lang.String fieldname, java.lang.Object value) Sets the value of the specified field using an object.
java.lang.String	toString() Converts the node to a string

Method Detail

getCloud

public Cloud getCloud()

Returns the cloud this node belongs to.

getNodeManager

public NodeManager getNodeManager()

Returns the node manager for this node.

getNumber

public int getNumber()

Returns the unique number for this node. Every node has a unique number wich can be used to refer to it. In addition to this number a node can have one or more aliases.

Returns:

the unique number for this node

See Also:

createAlias(String alias)

setValue

public void setValue(java.lang.String fieldname,
                     java.lang.Object value)

Sets the value of the specified field using an object. For example a field of type int can be set using an Integer. This change will not be visible to the cloud until the commit method is called.

Parameters:

fieldname - the name of the field to be updated

value - the new value for the given field

setIntValue

public void setIntValue(java.lang.String fieldname,
                        int value)

Sets the value of the specified field using an int. This change will not be visible to the cloud until the commit method is called.

Parameters:

fieldname - the name of the field to be updated

value - the new value for the given field

setFloatValue

public void setFloatValue(java.lang.String fieldname,
                          float value)

Sets the value of the specified field using a float. This change will not be visible to the cloud until the commit method is called.

Parameters:

fieldname - the name of the field to be updated

value - the new value for the given field

setDoubleValue

public void setDoubleValue(java.lang.String fieldname,
                           double value)

Sets the value of the specified field using a double. This change will not be visible to the cloud until the commit method is called.

Parameters:

fieldname - the name of the field to be updated

value - the new value for the given field

setByteValue

public void setByteValue(java.lang.String fieldname,
                         byte[] value)

Sets the value of the specified field using a byte array. This change will not be visible to the cloud until the commit method is called.

Parameters:

fieldname - the name of the field to be updated

value - the new value for the given field

setLongValue

public void setLongValue(java.lang.String fieldname,
                         long value)

Sets the value of the specified field using a long. This change will not be visible to the cloud until the commit method is called.

Parameters:

fieldname - the name of the field to be updated

value - the new value for the given field

setStringValue

public void setStringValue(java.lang.String fieldname,
                           java.lang.String value)

Sets the value of the specified field using a String. This change will not be visible to the cloud until the commit method is called.

Parameters:

fieldname - the name of the field to be updated

value - the new value for the given field

getValue

public java.lang.Object getValue(java.lang.String fieldname)

Returns the value of the specified field as an object. For example a field of type int is returned as an Integer.

Parameters:

fieldname - the name of the field to be returned

Returns:

the value of the specified field

getBooleanValue

public boolean getBooleanValue(java.lang.String fieldname)

Returns the value of the specified field as a boolean.

Parameters:

fieldname - the name of the field to be returned

Returns:

the value of the specified field

getNodeValue

public Node getNodeValue(java.lang.String fieldname)

Returns the value of the specified field as a Node. If the value is not itself a Node, this call attempts to convert the original field value to a Node, by trying to retrieve a Node using the field value as a Node number or alias.
For instance, getNodeValue("destination"), when run on a OAlias object, returns the referenced destination node (instead of teh number, which is what it normally holds).
Mosty, this call is used in cluster nodes (nodes retrived by using the Cloud.getList method. A cluster node returns one of its compound nodes when an appropriate nodemanager name (name from the nodepath) is specified. I.e. getNodeValue("people") will return the people-node in the cluster. If this fails, the method returns null.
Notes: the behavior of getNodeValue when called on a field that is not intended to be a node reference is currently undefined and is not encouraged.
Calling this method with field "number" or null lets the Node return a reference to itself, regardless of the actual value of the number field or status of the Node.

Parameters:

fieldname - the name of the field to be returned

Returns:

the value of the specified field

See Also:

Cloud.getList(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)

getIntValue

public int getIntValue(java.lang.String fieldname)

Returns the value of the specified field as an int.

Parameters:

fieldname - the name of the field to be returned

Returns:

the value of the specified field

getFloatValue

public float getFloatValue(java.lang.String fieldname)

Returns the value of the specified field as a float.

Parameters:

fieldname - the name of the field to be returned

Returns:

the value of the specified field

getLongValue

public long getLongValue(java.lang.String fieldname)

Returns the value of the specified field as a long.

Parameters:

fieldname - the name of the field to be returned

Returns:

the value of the specified field

getDoubleValue

public double getDoubleValue(java.lang.String fieldname)

Returns the value of the specified field as a double.

Parameters:

fieldname - the name of the field to be returned

Returns:

the value of the specified field

getByteValue

public byte[] getByteValue(java.lang.String fieldname)

Returns the value of the specified field as a byte array.

Parameters:

fieldname - the name of the field to be returned

Returns:

the value of the specified field

getStringValue

public java.lang.String getStringValue(java.lang.String fieldname)

Returns the value of the specified field as a String.

Parameters:

fieldname - the name of the field to be returned

Returns:

the value of the specified field

commit

public void commit()

Commit the node to the database. Makes this node and/or the changes made to this node visible to the cloud. If this method is called for the first time on this node it will make this node visible to the cloud, otherwise the modifications made to this node using the set methods will be made visible to the cloud. This action fails if the current node is not in edit mode. If the node is in a transaction, nothing happens - actual committing occurs through the transaction.

cancel

public void cancel()

Cancel changes to a node This fails if the current node is not in edit mode. If the node is in a transaction, nothing happens - actual committing occurs through the transaction.

delete

public void delete()

Removes the Node. Throws an exception if still has relations. Like delete(false).

delete

public void delete(boolean deleteRelations)

Removes the Node.

Parameters:

deleteRelations - a boolean. If true, then first all existing relations with this node will be removed.

toString

public java.lang.String toString()

Converts the node to a string

Overrides:

toString in class java.lang.Object

hasRelations

public boolean hasRelations()

Checks whether this node has any relations.

Returns:

true if the node has relations

deleteRelations

public void deleteRelations()

Removes all relation nodes attached to this node.

deleteRelations

public void deleteRelations(java.lang.String relationManager)

Removes all relation nodes with a certain relation manager that are attached to this node.

Parameters:

relationManager - the name of the relation manager the removed relation nodes should have

getRelations

public RelationList getRelations()

Returns all relation nodes attached to this node.

Returns:

a list of relation nodes

getRelations

public RelationList getRelations(java.lang.String relationManager)

Returns all relation nodes attached to this node that have a specific relation manager.

Parameters:

relationManager - the name of the relation manager the returned relation nodes should have

Returns:

a list of relation nodes

countRelations

public int countRelations()

Returns the number of relations this node has with other nodes.

Returns:

the number of relations this node has with other nodes

countRelations

public int countRelations(java.lang.String relationManager)

Returns the number of relation nodes attached to this node that have a specific relation manager.

Returns:

the number of relation nodes attached to this node that have a specific relation manager

getRelatedNodes

public NodeList getRelatedNodes()

Returns all related nodes. The returned nodes are not the nodes directly attached to this node (the relation nodes) but the nodes attached to the relation nodes of this node.

Returns:

a list of all related nodes

getRelatedNodes

public NodeList getRelatedNodes(java.lang.String nodeManager)

Returns all related nodes that have a specific node manager. The returned nodes are not the nodes directly attached to this node (the relation nodes) but the nodes attached to the relation nodes of this node.

Parameters:

nodeManager - the name of the node manager the returned nodes should have

Returns:

a list of related nodes

countRelatedNodes

public int countRelatedNodes(java.lang.String type)

Returns the number of related nodes that have a specific node manager. The counted nodes are not the nodes directly attached to this node (the relation nodes) but the nodes attached to the relation nodes of this node.

Parameters:

nodeManager - the name of the node manager the counted nodes should have

Returns:

the number of related nodes that have a specific node manager

getAliases

public java.util.List getAliases()

Returns all aliases for this node.

Returns:

a list of alias names for this node

createAlias

public void createAlias(java.lang.String alias)

Create an alias for this node. An alias can be used to refer to a node in addition to his number.

Parameters:

alias - the alias to be created for this node

Throws:

BridgeException - if the alias allready exists

deleteAlias

public void deleteAlias(java.lang.String alias)

Delete an alias for this node.

Parameters:

alias - the alias to be removed for this node

createRelation

public Relation createRelation(Node destinationNode,
                               RelationManager relationManager)

Adds a relation between this node and a specified node to the cloud.

Parameters:

destinationNode - the node to which you want to relate this node

relationManager - the relation manager you want to use

Returns:

the added relation

Throws:

BridgeException - if the relation manager is not the right one for this type of relation

setContext

public void setContext(java.lang.String context)

set the Context of the current Node

Parameters:

context - The context to which the current node should belong,

Throws:

BridgeException - Dunno?

java.lang.SecurityException - When not the approperate rights (change context)

getContext

public java.lang.String getContext()

get the Context of the current Node

Returns:

the current context of the node

Throws:

BridgeException - Dunno?

java.lang.SecurityException - When not the approperate rights (read rights)

getPossibleContexts

public StringList getPossibleContexts()

get the Contextes which can be set to this specific node

Returns:

the contextes from which can be chosen

Throws:

BridgeException - Dunno?

java.lang.SecurityException - When not the approperate rights (read rights)

mayWrite

public boolean mayWrite()

Check write rights on this node.

Returns:

whether the node may be changed by the current user

mayDelete

public boolean mayDelete()

Check delete rights on this node.

Returns:

whether the node may be deleted by the current user

mayLink

public boolean mayLink()

Check link rights on this node.

Returns:

whether the current user may link to this node

mayChangeContext

public boolean mayChangeContext()

Check context-change rights on this node.

Returns:

whether the current user may change the context of this node