| org.mmbase.bridge.Node
All known Subclasses: org.mmbase.bridge.util.NodeWrapper, org.mmbase.bridge.implementation.BasicNode, org.mmbase.bridge.implementation.VirtualNode, org.mmbase.bridge.util.MapNode, org.mmbase.bridge.util.AbstractNode,
Node | public interface Node extends Comparable<Node>(Code) | | Describes an object in the cloud.
author: Rob Vermeulen author: Pierre van Rooden version: $Id: Node.java,v 1.76 2008/02/16 22:13:53 nklasens Exp $ |
Method Summary | |
public void | cancel() Cancel changes to a node
This fails if the current node is not in edit mode. | public void | commit() Commit the node to the database. | public int | countRelatedNodes(String nodeManager) Returns the number of related nodes that have a specific node manager. | public int | countRelatedNodes(NodeManager otherNodeManager, String role, String searchDir) | public int | countRelations() Returns the number of relations this node has with other nodes. | public int | countRelations(String relationManager) Returns the number of relation nodes attached to this node that have a
specific relation manager. | public void | createAlias(String alias) Create an alias for this node. | public Parameters | createParameters(String functionName) Creates a parameter list for a function. | public Relation | createRelation(Node destinationNode, RelationManager relationManager) Adds a relation between this node and a specified node to the cloud. | public void | delete() Removes the Node. | public void | delete(boolean deleteRelations) Removes the Node.
Parameters: deleteRelations - a boolean. | public void | deleteAlias(String alias) Delete an alias for this node. | public void | deleteRelations() Removes all relation nodes attached to this node. | public void | deleteRelations(String relationManager) Removes all relation nodes with a certain relation manager that are
attached to this node. | public StringList | getAliases() Returns all aliases for this node. | public boolean | getBooleanValue(String fieldName) Returns the value of the specified field as a boolean .
If the actual value is numeric, this call returns true
if the value is a positive, non-zero, value. | public byte[] | getByteValue(String fieldName) Returns the value of the specified field as a byte array .
This function returns either the value of a byte field, or the byte value of a string
(converted using the default encoding, i.e. | public Set<String> | getChanged() A Set of Strings containing the names of all changed fields. | public Cloud | getCloud() Returns the cloud this node belongs to. | public String | getContext() | public Date | getDateValue(String fieldName) | public double | getDoubleValue(String fieldName) Returns the value of the specified field as a double .
This function attempts to convert the value to a double.
Numeric fields are simply converted. | public FieldValue | getFieldValue(String fieldName) Returns the value of the specified field as a FieldValue object. | public FieldValue | getFieldValue(Field field) Returns the value of the specified field as a FieldValue object. | public float | getFloatValue(String fieldName) Returns the value of the specified field as a float .
This function attempts to convert the value to a float.
Numeric fields are simply converted.
Boolean fields return 0.0 if false, and 1.0 if true.
String fields are parsed.
If a parsed string contains an error, ot the field value is not of a type that can be converted
(i.e. | public Function> | getFunction(String functionName) Returns a Fuction object.
The object returned is a
org.mmbase.util.functions.Function object.
You need to explixitly cast the result to this object, since not all bridge
implementations (i.e. | public FieldValue | getFunctionValue(String functionName, List parameters) Returns the value of the specified function on the node. | public Collection<Function<?>> | getFunctions() | public InputStream | getInputStreamValue(String fieldName) Returns the value of the specified field as a java.io.InputStream This is
especially useful for large byte-array fields. | public int | getIntValue(String fieldName) Returns the value of the specified field as an int .
Numeric fields are simply converted. | public List | getListValue(String fieldName) | public long | getLongValue(String fieldName) Returns the value of the specified field as a long .
This function attempts to convert the value to a long.
Numeric fields are simply converted. | public NodeManager | getNodeManager() Returns the node manager for this node. | public Node | getNodeValue(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 the number, which is
what it normally holds).
Mostly, this call is used in cluster nodes (nodes retrieved by using the
Cloud.getList method. | public int | getNumber() Returns the unique number for this node. | public Object | getObjectValue(String fieldName) Returns the field's value as an object. | public StringList | getPossibleContexts() Contacts the security implementation to find out to which other possible contexts the
context of this node may be set. | public NodeList | getRelatedNodes() Returns all related nodes. | public NodeList | getRelatedNodes(String nodeManager) Returns all related nodes that have a specific node manager. | public NodeList | getRelatedNodes(NodeManager nodeManager) Returns all related nodes that have a specific node manager. | public NodeList | getRelatedNodes(String nodeManager, String role, String searchDir) Returns all related nodes that have a specific node manager and role. | public NodeList | getRelatedNodes(NodeManager nodeManager, String role, String searchDir) Returns all related nodes that have a specific node manager and role. | public RelationList | getRelations() Returns all relation nodes attached to this node. | public RelationList | getRelations(String role) | public RelationList | getRelations(String role, String nodeManager) | public RelationList | getRelations(String role, NodeManager nodeManager) | public RelationList | getRelations(String role, NodeManager nodeManager, String searchDir) | public long | getSize(String fieldName) Returns the 'size' (e.g. | public String | getStringValue(String fieldName) Returns the value of the specified field as a String . | public Object | getValue(String fieldName) Returns the value of the specified field as an object. | public Object | getValueWithoutProcess(String fieldName) Like getObjectValue, but skips any processing that MMBase would normally perform on a field. | public Document | getXMLValue(String fieldName) Returns the value of the specified field as a dom.Document
If the node value is not itself a Document, the method attempts to
attempts to convert the String value into an XML. | public Element | getXMLValue(String fieldName, Document tree) Returns the value of the specified field as a dom.Element
If the node value is not itself a Document, the method attempts to
attempts to convert the String value into an XML. | public boolean | hasRelations() Checks whether this node has any relations. | public boolean | isChanged(String fieldName) Whether a certain field's value was changed since the last commit. | public boolean | isChanged() Whether field values were changed since the last commit. | public boolean | isNew() Whether this Node is new (not yet committed). | public boolean | isNodeManager() Determine whether this Node is a NodeManager. | public boolean | isNull(String fieldName) Whether the value for the specified field is null . | public boolean | isRelation() Determine whether this Node is a Relation. | public boolean | isRelationManager() Determine whether this Node is a RelationManager. | public boolean | mayChangeContext() Check context-change rights on this node. | public boolean | mayDelete() Check delete rights on this node. | public boolean | mayWrite() Check write rights on this node. | public void | setBooleanValue(String fieldName, boolean value) Sets the value of the specified field using an boolean . | public void | setByteValue(String fieldName, byte[] value) Sets the value of the specified field using a byte array . | public void | setContext(String context) | public void | setDateValue(String fieldName, Date value) Sets the value of the specified field using a Date . | public void | setDoubleValue(String fieldName, double value) Sets the value of the specified field using a double . | public void | setFloatValue(String fieldName, float value) Sets the value of the specified field using a float . | public void | setInputStreamValue(String fieldName, InputStream value, long size) Sets the value of the specified field using a java.io.InputStream . | public void | setIntValue(String fieldName, int value) Sets the value of the specified field using an int . | public void | setListValue(String fieldName, List value) Sets the value of the specified field using a List . | public void | setLongValue(String fieldName, long value) Sets the value of the specified field using a long . | public void | setNodeValue(String fieldName, Node value) Sets the value of the specified field using an Node . | public void | setObjectValue(String fieldName, Object value) Sets the value of the specified field using an object, but without dispatching to the right
type first. | public void | setStringValue(String fieldName, String value) Sets the value of the specified field using a String . | public void | setValue(String fieldName, Object value) Sets the value of the specified field using an object, but delegated to the right
set--Value depending on the type of the field. | public void | setValueWithoutProcess(String fieldName, Object value) Like setValue, but skips any processing that MMBase would normally perform on a field.
You can use this to set data on fields that are 'system' defined, to prevent (among other
things) infinite recursion. | public void | setXMLValue(String fieldName, Document value) | public NodeManager | toNodeManager() Returns this as a NodeManager. | public Relation | toRelation() Returns this as a Relation. | public RelationManager | toRelationManager() Returns this as a RelationManager. | public String | toString() | public Collection<String> | validate() Validates a node by checking the values from it's fields against the constraints of
each field's datatype. |
cancel | public void cancel()(Code) | | 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.
|
commit | public void commit()(Code) | | Commit the node to the database.
Prior to committing, the values are processed by any commit-processors associated with the datatype of the node's fields),
then validated.
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.
throws: BridgeException - throws: IllegalArgumentException - If certain value of the node are invalid according to their data type. |
countRelatedNodes | public int countRelatedNodes(String nodeManager)(Code) | | 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 nodesshould have the number of related nodes that have a specific nodemanager |
countRelatedNodes | public int countRelatedNodes(NodeManager otherNodeManager, String role, String searchDir)(Code) | | Parameters: otherNodeManager - the node manager the nodes should have Parameters: role - the role of the relation Parameters: searchDir - the direction of the relation number of related nodes since: MMBase-1.7 |
countRelations | public int countRelations()(Code) | | Returns the number of relations this node has with other nodes.
the number of relations this node has with other nodes |
countRelations | public int countRelations(String relationManager)(Code) | | Returns the number of relation nodes attached to this node that have a
specific relation manager.
Parameters: relationManager - relation manager the number of relation nodes attached to this node that have aspecific relation manager |
createAlias | public void createAlias(String alias)(Code) | | 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 |
createParameters | public Parameters createParameters(String functionName)(Code) | | Creates a parameter list for a function.
The list can be filled with parameter values by either using the List set(int, Object) method, to
set values for parameters by psoition, or by using the set(String, Object) method to
set parameters by name.
This object can then be passed to the getFunctionValue method.
Note that adding extra parameters (with the add(Object) method) won't work and may cause exceptions.
since: MMBase-1.8 Parameters: functionName - name of the function a org.mmbase.util.functions.Parameters object. throws: NotFoundException - if the function does not exist |
createRelation | public Relation createRelation(Node destinationNode, RelationManager relationManager)(Code) | | 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 Parameters: relationManager - the relation manager you want to use the added relation throws: BridgeException - if the relation manager is not the right onefor this type of relation |
delete | public void delete()(Code) | | Removes the Node. Throws an exception if still has relations. Like delete(false).
|
delete | public void delete(boolean deleteRelations)(Code) | | Removes the Node.
Parameters: deleteRelations - a boolean. If true, then first allexisting relations with this node will be removed. |
deleteAlias | public void deleteAlias(String alias)(Code) | | Delete an alias for this node.
Parameters: alias - the alias to be removed for this node |
deleteRelations | public void deleteRelations()(Code) | | Removes all relation nodes attached to this node.
|
deleteRelations | public void deleteRelations(String relationManager)(Code) | | Removes all relation nodes with a certain relation manager that are
attached to this node.
Parameters: relationManager - the name of the relation manager the removedrelation nodes should have |
getAliases | public StringList getAliases()(Code) | | Returns all aliases for this node.
a list of alias names for this node |
getBooleanValue | public boolean getBooleanValue(String fieldName)(Code) | | Returns the value of the specified field as a boolean .
If the actual value is numeric, this call returns true
if the value is a positive, non-zero, value. In other words, values '0'
and '-1' are considered false .
If the value is a string, this call returns true if
the value is "true" or "yes" (case-insensitive).
In all other cases (including calling byte fields), false
is returned.
Parameters: fieldName - the name of the field to be returned the value of the specified field |
getByteValue | public byte[] getByteValue(String fieldName)(Code) | | Returns the value of the specified field as a byte array .
This function returns either the value of a byte field, or the byte value of a string
(converted using the default encoding, i.e. UTF8)
Other types of values return an empty byte-array.
Parameters: fieldName - the name of the field to be returned the value of the specified field |
getChanged | public Set<String> getChanged()(Code) | | A Set of Strings containing the names of all changed fields.
Set of changed fields since: MMBase-1.8 |
getCloud | public Cloud getCloud()(Code) | | Returns the cloud this node belongs to.
the Cloud |
getContext | public String getContext()(Code) | | Get the security context of the current Node
the current context of the node (as a String) throws: SecurityException - When appropriate rights to perform this are lacking (read rights) |
getDateValue | public Date getDateValue(String fieldName)(Code) | | Parameters: fieldName - the name of the field to be returned the value of the specified field since: MMBase-1.8 |
getDoubleValue | public double getDoubleValue(String fieldName)(Code) | | Returns the value of the specified field as a double .
This function attempts to convert the value to a double.
Numeric fields are simply converted. Double may be truncated.
Boolean fields return 0.0 if false, and 1.0 if true.
String fields are parsed.
If a parsed string contains an error, ot the field value is not of a type that can be converted
(i.e. a byte array), this function returns -1.0.
Parameters: fieldName - the name of the field to be returned the value of the specified field |
getFieldValue | public FieldValue getFieldValue(String fieldName) throws NotFoundException(Code) | | Returns the value of the specified field as a FieldValue object.
since: MMBase-1.6 Parameters: fieldName - the name of the field whose value to return the value of the specified field throws: NotFoundException - is the field does not exist |
getFieldValue | public FieldValue getFieldValue(Field field)(Code) | | Returns the value of the specified field as a FieldValue object.
since: MMBase-1.6 Parameters: field - the Field object whose value to return the value of the specified field |
getFloatValue | public float getFloatValue(String fieldName)(Code) | | Returns the value of the specified field as a float .
This function attempts to convert the value to a float.
Numeric fields are simply converted.
Boolean fields return 0.0 if false, and 1.0 if true.
String fields are parsed.
If a parsed string contains an error, ot the field value is not of a type that can be converted
(i.e. a byte array), this function returns -1.0.
Parameters: fieldName - the name of the field to be returned the value of the specified field |
getFunctionValue | public FieldValue getFunctionValue(String functionName, List parameters)(Code) | | Returns the value of the specified function on the node. A
function normally has arguments, which can be supplied with a
List.
since: MMBase-1.6 Parameters: functionName - name of the function Parameters: parameters - list with parameters for the fucntion the result value of executing the function throws: NotFoundException - if the function does not exist |
getInputStreamValue | public InputStream getInputStreamValue(String fieldName)(Code) | | Returns the value of the specified field as a java.io.InputStream This is
especially useful for large byte-array fields. By this you can avoid them to be completely
stored in memory.
Parameters: fieldName - the name of the field value of field as a input stream since: MMBase-1.8 |
getIntValue | public int getIntValue(String fieldName)(Code) | | Returns the value of the specified field as an int .
Numeric fields are simply converted. Double and float values may be truncated.
For Node values, the numeric key is returned.
Long values return -1 of the value is too large.
Boolean fields return 0 if false, and 1 if true.
String fields are parsed.
If a parsed string contains an error, ot the field value is not of a type that can be converted
(i.e. a byte array), this function returns -1
Parameters: fieldName - the name of the field to be returned the value of the specified field |
getListValue | public List getListValue(String fieldName)(Code) | | Parameters: fieldName - the name of the field to be returned the value of the specified fieldnot yet working since: MMBase-1.8 |
getLongValue | public long getLongValue(String fieldName)(Code) | | Returns the value of the specified field as a long .
This function attempts to convert the value to a long.
Numeric fields are simply converted. Double and float values may be truncated.
Boolean fields return 0 if false, and 1 if true.
String fields are parsed.
If a parsed string contains an error, ot the field value is not of a type that can be converted
(i.e. a byte array), this function returns -1
Parameters: fieldName - the name of the field to be returned the value of the specified field |
getNodeManager | public NodeManager getNodeManager()(Code) | | Returns the node manager for this node.
the node manager |
getNodeValue | public Node getNodeValue(String fieldName)(Code) | | 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 the number, which is
what it normally holds).
Mostly, this call is used in cluster nodes (nodes retrieved 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 the value of the specified field See Also: Cloud.getList(StringStringStringStringStringStringStringboolean) |
getNumber | public int getNumber()(Code) | | Returns the unique number for this node. Every node has a unique number
which can be used to refer to it. In addition to this number a node can
have one or more aliases.
A value of -1 indicates an invalid number.
Other negative values may be used for temporary ids (but not true node numbers).
This may differ by implementation.
the unique number for this node See Also: Node.createAlias(String alias) |
getObjectValue | public Object getObjectValue(String fieldName)(Code) | | Returns the field's value as an object. It is not delegated to the right get--Value.
Parameters: fieldName - name of the field object value since: MMBase-1.7 |
getPossibleContexts | public StringList getPossibleContexts()(Code) | | Contacts the security implementation to find out to which other possible contexts the
context of this node may be set.
A StringList containing the contexts which can be used in setContext on this node. throws: SecurityException - When appropriate rights to perform this are lacking (read rights) |
getRelatedNodes | public NodeList getRelatedNodes()(Code) | | 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.
a list of all related nodes |
getRelatedNodes | public NodeList getRelatedNodes(String nodeManager)(Code) | | 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 nodesshould have a list of related nodes |
getRelatedNodes | public NodeList getRelatedNodes(NodeManager nodeManager)(Code) | | 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 node manager the returned nodes should have, can be null a list of related nodes |
getRelatedNodes | public NodeList getRelatedNodes(String nodeManager, String role, String searchDir)(Code) | | Returns all related nodes that have a specific node manager and role.
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.
since: MMBase-1.6 Parameters: nodeManager - the name of the node manager the returned nodesshould have Parameters: role - the role of the relation Parameters: searchDir - the direction of the relation a list of related nodes |
getRelatedNodes | public NodeList getRelatedNodes(NodeManager nodeManager, String role, String searchDir)(Code) | | Returns all related nodes that have a specific node manager and role.
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.
since: MMBase-1.6 Parameters: nodeManager - the node manager the returned nodes should have Parameters: role - the role of the relation Parameters: searchDir - the direction of the relation a list of related nodes |
getRelations | public RelationList getRelations()(Code) | | Returns all relation nodes attached to this node.
a list of relation nodes |
getRelations | public RelationList getRelations(String role)(Code) | | Returns all relation nodes attached to this node that have a specific
role
Parameters: role - the name of the role the returnedrelation nodes should have a list of relation nodes |
getRelations | public RelationList getRelations(String role, String nodeManager)(Code) | | Returns all relation nodes attached to this node that have a specific
role, or refer a node from a specific nodemanager
Parameters: role - the name of the role the returnedrelation nodes should have Parameters: nodeManager - the name of the nodemanager for the nodes the returnedrelation nodes should have a relation to a list of relation nodes |
getRelations | public RelationList getRelations(String role, NodeManager nodeManager)(Code) | | Returns all relation nodes attached to this node that have a specific
role, or refer a node from a specific nodemanager
Parameters: role - the name of the role the returnedrelation nodes should have Parameters: nodeManager - the nodemanager for the nodes the returnedrelation nodes should have a relation to (can be null) a list of relation nodes |
getRelations | public RelationList getRelations(String role, NodeManager nodeManager, String searchDir)(Code) | | Parameters: role - forward role of a relation Parameters: nodeManager - node manager on the other side of the relation Parameters: searchDir - the direction of the relation List of relations since: MMBase-1.7 |
getSize | public long getSize(String fieldName)(Code) | | Returns the 'size' (e.g. the number of bytes of a byte array) for the specified field. This
avoids acquiring the complete value if you only want to know how big the value of the field is.
Parameters: fieldName - the name of the field the 'size' since: MMBase-1.8 |
getStringValue | public String getStringValue(String fieldName)(Code) | | Returns the value of the specified field as a String .
Byte arrays are converted to string using the default encoding (UTF8).
Node values return a string representation of their numeric key.
For other values the result is calling the toString() method on the actual object.
Parameters: fieldName - the name of the field to be returned the value of the specified field |
getValue | public Object getValue(String fieldName)(Code) | | Returns the value of the specified field as an object. For example a
field of type int is returned as an Integer .
The object type may vary and is dependent on how data was stored in a field.
I.e. It may be possible for an Integer field to return it's value as a String
if it was stored that way in the first place.
Parameters: fieldName - the name of the field to be returned the value of the specified field |
getValueWithoutProcess | public Object getValueWithoutProcess(String fieldName)(Code) | | Like getObjectValue, but skips any processing that MMBase would normally perform on a field.
You can use this to get data from a field for validation purposes.
Parameters: fieldName - name of field value without processing since: MMBase-1.8 |
getXMLValue | public Document getXMLValue(String fieldName) throws IllegalArgumentException(Code) | | Returns the value of the specified field as a dom.Document
If the node value is not itself a Document, the method attempts to
attempts to convert the String value into an XML.
This included the empty string, but not the 'null' value.
If the value is null, this method returns null
Parameters: fieldName - the name of the field to be returned the value of the specified field as a DOM Element or null throws: IllegalArgumentException - if the value cannot be converted to xml. since: MMBase-1.6 |
getXMLValue | public Element getXMLValue(String fieldName, Document tree) throws IllegalArgumentException(Code) | | Returns the value of the specified field as a dom.Element
If the node value is not itself a Document, the method attempts to
attempts to convert the String value into an XML.
This method fails (throws a IllegalArgumentException) if the Field is not of type TYPE_XML.
If the value cannot be converted, this method returns null
Parameters: fieldName - the name of the field to be returned Parameters: tree - the DOM Document to which the Element is added(as the document root element) the value of the specified field as a DOM Element or null throws: IllegalArgumentException - if the value cannot be converted to xml. since: MMBase-1.6 |
hasRelations | public boolean hasRelations()(Code) | | Checks whether this node has any relations.
true if the node has relations |
isChanged | public boolean isChanged(String fieldName)(Code) | | Whether a certain field's value was changed since the last commit.
Parameters: fieldName - the name of the field true when field's value was changed since: MMBase-1.8 |
isChanged | public boolean isChanged()(Code) | | Whether field values were changed since the last commit.
true when changed since: MMBase-1.8 |
isNew | public boolean isNew()(Code) | | Whether this Node is new (not yet committed).
true when new since: MMBase-1.8 |
isNodeManager | public boolean isNodeManager()(Code) | | Determine whether this Node is a NodeManager.
since: MMBase-1.6 true if this Node is a NodeManager. |
isNull | public boolean isNull(String fieldName)(Code) | | Whether the value for the specified field is null . This avoids acquiring the
complete value if you only want to check if for emptiness.
Parameters: fieldName - the name of the field true when value is null since: MMBase-1.8 |
isRelation | public boolean isRelation()(Code) | | Determine whether this Node is a Relation.
since: MMBase-1.6 true if this Node is a Relation. |
isRelationManager | public boolean isRelationManager()(Code) | | Determine whether this Node is a RelationManager.
since: MMBase-1.6 true if this Node is a RelationManager. |
mayChangeContext | public boolean mayChangeContext()(Code) | | Check context-change rights on this node.
Whether the current user may change the context of this node |
mayDelete | public boolean mayDelete()(Code) | | Check delete rights on this node.
Whether the node may be deleted by the current user |
mayWrite | public boolean mayWrite()(Code) | | Check write rights on this node.
Whether the node may be changed by the current user |
setBooleanValue | public void setBooleanValue(String fieldName, boolean value)(Code) | | Sets the value of the specified field using an boolean .
This change will not be visible to the cloud until the commit method is
called.
since: MMBase-1.6 Parameters: fieldName - the name of the field to be updated Parameters: value - the new value for the given field |
setByteValue | public void setByteValue(String fieldName, byte[] value)(Code) | | 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 Parameters: value - the new value for the given field |
setContext | public void setContext(String context)(Code) | | Sets the security context of this Node (AKA the 'owner' field)
Parameters: context - The security context to which this node should belong, throws: SecurityException - When appropriate rights to perform this are lacking (write / change context rights) |
setDateValue | public void setDateValue(String fieldName, Date value)(Code) | | Sets the value of the specified field using a Date .
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 Parameters: value - the new value for the given field since: MMBase-1.8 |
setDoubleValue | public void setDoubleValue(String fieldName, double value)(Code) | | 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 Parameters: value - the new value for the given field |
setFloatValue | public void setFloatValue(String fieldName, float value)(Code) | | 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 Parameters: value - the new value for the given field |
setInputStreamValue | public void setInputStreamValue(String fieldName, InputStream value, long size)(Code) | | Sets the value of the specified field using a java.io.InputStream .
Parameters: fieldName - the name of the field to be updated Parameters: value - the new value for the given field Parameters: size - size of input stream since: MMBase-1.8. |
setIntValue | public void setIntValue(String fieldName, int value)(Code) | | 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 Parameters: value - the new value for the given field |
setListValue | public void setListValue(String fieldName, List value)(Code) | | Sets the value of the specified field using a List .
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 Parameters: value - the new value for the given field// not yet working since: MMBase-1.8 |
setLongValue | public void setLongValue(String fieldName, long value)(Code) | | 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 Parameters: value - the new value for the given field |
setNodeValue | public void setNodeValue(String fieldName, Node value)(Code) | | Sets the value of the specified field using an Node .
This change will not be visible to the cloud until the commit method is
called.
since: MMBase-1.6 Parameters: fieldName - the name of the field to be updated Parameters: value - the new value for the given field |
setObjectValue | public void setObjectValue(String fieldName, Object value)(Code) | | Sets the value of the specified field using an object, but without dispatching to the right
type first.
Parameters: fieldName - the name of the field to be updated Parameters: value - the new value for the given field since: MMBase-1.7 |
setStringValue | public void setStringValue(String fieldName, String value)(Code) | | 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 Parameters: value - the new value for the given field |
setValue | public void setValue(String fieldName, Object value)(Code) | | Sets the value of the specified field using an object, but delegated to the right
set--Value depending on the type of the field.
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 Parameters: value - the new value for the given field |
setValueWithoutProcess | public void setValueWithoutProcess(String fieldName, Object value)(Code) | | Like setValue, but skips any processing that MMBase would normally perform on a field.
You can use this to set data on fields that are 'system' defined, to prevent (among other
things) infinite recursion. Use with care - in general processing of a field has a purpose!
Parameters: fieldName - name of field Parameters: value - new value of the field since: MMBase-1.8 |
setXMLValue | public void setXMLValue(String fieldName, Document value)(Code) | | Set's the value of the specified field as a dom.Element
Parameters: fieldName - the name of the field to be returned Parameters: value - the DOM Document to has to be set, if not correct doc-type,system will try to convert it to the wanted type. since: MMBase-1.6 |
toNodeManager | public NodeManager toNodeManager()(Code) | | Returns this as a NodeManager.
since: MMBase-1.6 a NodeManager object throws: ClassCastException - if the Node is not a NodeManager |
toRelation | public Relation toRelation()(Code) | | Returns this as a Relation.
since: MMBase-1.6 a Relation object throws: ClassCastException - if the Node is not a Relation |
toRelationManager | public RelationManager toRelationManager()(Code) | | Returns this as a RelationManager.
since: MMBase-1.6 a NodeManager object throws: ClassCastException - if the Node is not a RelationManager |
toString | public String toString()(Code) | | Converts the node to a string
string representation of a node |
validate | public Collection<String> validate()(Code) | | Validates a node by checking the values from it's fields against the constraints of
each field's datatype.
For performance reasons, it only validates fields that actually changed (as of MMBase 1.8.4),
or when a new node is created.
This method is called by the
Node.commit method, after commit processors are run.
Note that because commit processors may make necessary changes to field values, it is possible for
validate() to fail when used outside the commit process if the constraints are set too strict.
Collection of errors as String (in the current locale of the cloud) or an empty collection if everything ok. since: MMBase-1.8 |
|
|