public abstract class AbstractNodeManager extends AbstractNode implements NodeManager
VirtualNodeManager).NodeManager| Modifier and Type | Field and Description |
|---|---|
protected Cloud |
cloud |
protected Map<String,Object> |
values |
GUI_PLURAL, GUI_SINGULAR, ORDER_CREATE, ORDER_EDIT, ORDER_LIST, ORDER_NONE, ORDER_SEARCHCLOUD_COMMITNODE_KEY| Modifier | Constructor and Description |
|---|---|
protected |
AbstractNodeManager(Cloud c) |
| Modifier and Type | Method and Description |
|---|---|
FieldList |
createFieldList()
Returns a new, empty field list for this nodemanager
|
Node |
createNode()
Creates a new node.
|
NodeList |
createNodeList()
Returns a new, empty node list for this nodemanager
|
NodeQuery |
createQuery()
Creates a query for this NodeNanager.
|
RelationList |
createRelationList()
Returns a new, empty relation list for this nodemanager
|
protected void |
edit(int action) |
RelationManagerList |
getAllowedRelations()
Retrieve all relation managers that can be used to create relations for objects of this nodemanager.
|
RelationManagerList |
getAllowedRelations(NodeManager nodeManager,
String role,
String direction)
Retrieve all relation managers that can be used to create relations for objects from this nodemanager,
to the specified manager, using the specified role and direction.
|
RelationManagerList |
getAllowedRelations(String nodeManager,
String role,
String direction)
Retrieve all relation managers that can be used to create relations for objects from this nodemanager,
to the specified manager, using the specified role and direction.
|
Cloud |
getCloud()
Returns the cloud to which this manager belongs.
|
NodeManagerList |
getDescendants()
Retrieve a list of descendant nodemanagers (the nodemanagers that - possibly indirectly - extend from this nodemanager)
|
String |
getDescription()
Returns the description of this node manager.
|
String |
getDescription(Locale locale)
Returns the description of this node manager in a specified language.
|
Field |
getField(String fieldName)
Returns the field with the specified name.
|
FieldList |
getFields()
Returns a list of all fields defined for this node manager.
|
FieldList |
getFields(int sortOrder)
Retrieve a subset of field types of this NodeManager, depending on a given order.
|
protected abstract Map<String,Field> |
getFieldTypes() |
Collection<Function<?>> |
getFunctions()
This default implementation is based on
Node.getNodeManager().Node.getFunctions(). |
String |
getGUIName()
Returns the descriptive name of this node manager.
|
String |
getGUIName(int plurality)
Returns the descriptive name of this node manager.
|
String |
getGUIName(int plurality,
Locale locale)
Returns the descriptive name of this node manager ina a specified language.
|
String |
getInfo(String command)
Retrieve info from a node manager based on a command string.
|
String |
getInfo(String command,
javax.servlet.ServletRequest req,
javax.servlet.ServletResponse resp)
Retrieve info from a node manager based on a command string
Similar to the $MOD command in SCAN.
|
NodeList |
getList(NodeQuery query)
Executes a query and returns the result as nodes of this NodeManager (or of extensions)
|
NodeList |
getList(String command,
Map parameters)
Retrieve info (as a list of virtual nodes) from a node manager based on a command string.
|
NodeList |
getList(String command,
Map parameters,
javax.servlet.ServletRequest req,
javax.servlet.ServletResponse resp)
Retrieve info from a node manager based on a command string
Similar to the LIST command in SCAN.
|
NodeList |
getList(String constraints,
String sorted,
String directions)
Returns a list of nodes belonging to this node manager.
|
String |
getName()
Returns the name of this node manager.
|
NodeManager |
getNodeManager()
Returns the node manager for this node.
|
NodeManager |
getParent()
Retrieve the parent of this NodeManager (the Nodemanager that this nodemanager extends from)
|
Map<String,String> |
getProperties()
Retrieve a copy of the node manager's properties
|
String |
getProperty(String name)
Retrieve a property of the node manager.
|
long |
getSize(String fieldName)
Returns the 'size' (e.g.
|
Object |
getValueWithoutProcess(String fieldName)
Like getObjectValue, but skips any processing that MMBase would normally perform on a field.
|
boolean |
hasField(String fieldName)
Tests whether the field with the specified name exists in this nodemanager.
|
boolean |
isNodeManager()
Determine whether this Node is a NodeManager.
|
boolean |
mayCreateNode()
Check if the current user may create a new node of this type.
|
void |
setNodeManager(NodeManager nm)
Sets the node manager of this node.
|
protected void |
setSize(String fieldName,
long size) |
protected void |
setValueWithoutChecks(String fieldName,
Object value) |
NodeManager |
toNodeManager()
Returns this as a NodeManager.
|
String |
toString()
Converts the node to a string
|
cancel, checkWrite, commit, compareTo, countRelatedNodes, countRelatedNodes, countRelations, countRelations, createAlias, createFunctionValue, createParameters, createRelation, delete, delete, deleteAlias, deleteRelations, deleteRelations, equals, getAliases, getBooleanValue, getByteValue, getChanged, getContext, getDateValue, getDecimalValue, getDoubleValue, getFieldValue, getFieldValue, getFloatValue, getFunction, getFunctionMap, getFunctionValue, getInputStreamValue, getIntValue, getListValue, getLongValue, getNodeFunction, getNodeValue, getNumber, getObjectValue, getPossibleContexts, getRelatedNodes, getRelatedNodes, getRelatedNodes, getRelatedNodes, getRelatedNodes, getRelations, getRelations, getRelations, getRelations, getRelations, getStringValue, getValue, getXMLValue, getXMLValue, hashCode, hasRelations, isChanged, isChanged, isNew, isNull, isRelation, isRelationManager, mayChangeContext, mayDelete, mayWrite, processNull, setBooleanValue, setByteValue, setContext, setDateValue, setDecimalValue, setDoubleValue, setFloatValue, setInputStreamValue, setIntValue, setListValue, setLongValue, setNodeValue, setObjectValue, setStringValue, setValue, setValueWithoutProcess, setXMLValue, toNodeNumber, toRelation, toRelationManager, validateclone, finalize, getClass, notify, notifyAll, wait, wait, waitcancel, commit, countRelatedNodes, countRelatedNodes, countRelations, countRelations, createAlias, createParameters, createRelation, delete, delete, deleteAlias, deleteRelations, deleteRelations, getAliases, getBooleanValue, getByteValue, getChanged, getContext, getDateValue, getDecimalValue, getDoubleValue, getFieldValue, getFieldValue, getFloatValue, getFunction, getFunctionValue, getInputStreamValue, getIntValue, getListValue, getLongValue, getNodeValue, getNumber, getObjectValue, getPossibleContexts, getRelatedNodes, getRelatedNodes, getRelatedNodes, getRelatedNodes, getRelatedNodes, getRelations, getRelations, getRelations, getRelations, getRelations, getStringValue, getValue, getXMLValue, getXMLValue, hasRelations, isChanged, isChanged, isNew, isNull, isRelation, isRelationManager, mayChangeContext, mayDelete, mayWrite, setBooleanValue, setByteValue, setContext, setDateValue, setDecimalValue, setDoubleValue, setFloatValue, setInputStreamValue, setIntValue, setListValue, setLongValue, setNodeValue, setObjectValue, setStringValue, setValue, setValueWithoutProcess, setXMLValue, toRelation, toRelationManager, validatecompareToprotected AbstractNodeManager(Cloud c)
protected void setValueWithoutChecks(String fieldName, Object value)
setValueWithoutChecks in class AbstractNodepublic Object getValueWithoutProcess(String fieldName)
NodegetValueWithoutProcess in interface NodefieldName - name of fieldprotected void edit(int action)
protected void setSize(String fieldName, long size)
setSize in class AbstractNodepublic long getSize(String fieldName)
Nodepublic NodeManager getNodeManager()
NodegetNodeManager in interface Nodepublic void setNodeManager(NodeManager nm)
NodesetNodeManager in interface NodesetNodeManager in class AbstractNodepublic Cloud getCloud()
NodeManagergetCloud in interface NodegetCloud in interface NodeManagerpublic boolean isNodeManager()
NodeisNodeManager in interface NodeisNodeManager in class AbstractNodetrue if this Node is a NodeManager.public NodeManager toNodeManager()
NodetoNodeManager in interface NodetoNodeManager in class AbstractNodeNodeManager objectpublic Node createNode()
NodeManagercreateNode in interface NodeManagerNodepublic NodeList getList(String constraints, String sorted, String directions)
NodeManager
"number = 100" (!=, <, >, <= and >= can also be used)
"name = 'admin'",
"email IS NULL" (indicating the email field is empty)
"email LIKE '%.org'" (indication the email should end with .org)
"number BETWEEN 99 AND 101"
"name IN ('admin', 'anonymous')"
The NOT operator can be used to get the opposite result like:
"NOT (number = 100)"
"NOT (name = 'admin')",
"email IS NOT NULL"
"email NOT LIKE '%.org'" (indication the email should not end with .org)
"number NOT BETWEEN 99 AND 101"
"name NOT IN ('admin', 'anonymous')"
Some special functions (not part of standard SQL, but most databases
support them) can be used like:
"LOWER(name) = 'admin'" (to also allow 'Admin' to be selected) "LENGTH(name) > 5" (to only select names longer then 5 characters)Constraints can be linked together using AND and OR:
"((number=100) OR (name='admin') AND email LIKE '%.org')"The single quote can be escaped using it twice for every single occurence:
"name='aaa''bbb'" (if we want to find the string aaa'bbb)For more info consult a SQL tutorial like Jim Hoffman's introduction to Structured Query Language.
getList in interface NodeManagerconstraints - Constraints to prevent nodes from being
included in the resulting list which would normally
by included or null if no constraints
should be applied .sorted - A comma separated list of field names on which the
returned list should be sorted or null
if the order of the returned virtual nodes doesn't
matter.directions - A comma separated list of values indicating wether
to sort up (ascending) or down (descending) on the
corresponding field in the orderby
parameter or null if sorting on all
fields should be up.
The value DOWN (case insensitive) indicates
that sorting on the corresponding field should be
down, all other values (including the
empty value) indicate that sorting on the
corresponding field should be up.
If the number of values found in this parameter are
less than the number of fields in the
orderby parameter, all fields that
don't have a corresponding direction value are
sorted according to the last specified direction
value.public FieldList createFieldList()
NodeManagercreateFieldList in interface NodeManagerpublic NodeList createNodeList()
NodeManagercreateNodeList in interface NodeManagerpublic RelationList createRelationList()
NodeManagercreateRelationList in interface NodeManagerpublic boolean mayCreateNode()
NodeManagermayCreateNode in interface NodeManagerpublic NodeList getList(NodeQuery query)
NodeManagergetList in interface NodeManagerquery - query to executepublic NodeQuery createQuery()
NodeManagercreateQuery in interface NodeManagerNodeManager.getList(NodeQuery),
Cloud.createNodeQuery()public NodeList getList(String command, Map parameters, javax.servlet.ServletRequest req, javax.servlet.ServletResponse resp)
NodeManagergetList in interface NodeManagercommand - the info to obtain, i.e. "USER-OS".parameters - a hashtable containing the named parameters of the list.req - the Request item to use for obtaining user information. For backward compatibility.resp - the Response item to use for redirecting users. For backward compatibility.public NodeList getList(String command, Map parameters)
NodeManagergetList in interface NodeManagercommand - the info to obtain, i.e. "USER-OS".parameters - a hashtable containing the named parameters of the list.public RelationManagerList getAllowedRelations()
NodeManagergetAllowedRelations in interface NodeManagerpublic RelationManagerList getAllowedRelations(String nodeManager, String role, String direction)
NodeManagergetAllowedRelations in interface NodeManagernodeManager - the name of the nodemanger with which to make a relation, can be nullrole - the role with which to make a relation, can be nulldirection - the search direction ("source", "destination", "both"), can be nullpublic RelationManagerList getAllowedRelations(NodeManager nodeManager, String role, String direction)
NodeManagergetAllowedRelations in interface NodeManagernodeManager - the nodemanger with which to make a relation, can be nullrole - the role with which to make a relation, can be nulldirection - the search direction ("source", "destination", "both"), can be nullpublic String getInfo(String command)
NodeManagergetInfo in interface NodeManagercommand - the info to obtain, i.e. "USER-OS".public String getInfo(String command, javax.servlet.ServletRequest req, javax.servlet.ServletResponse resp)
NodeManagergetInfo in interface NodeManagercommand - the info to obtain, i.e. "USER-OS".req - the Request item to use for obtaining user information. For backward compatibility.resp - the Response item to use for redirecting users. For backward compatibility.public boolean hasField(String fieldName)
NodeManagerhasField in interface NodeManagerfieldName - the name of the field to be returnedtrue if the field with the requested name existspublic final FieldList getFields()
NodeManagergetFields in interface NodeManagerpublic final FieldList getFields(int sortOrder)
NodeManagergetFields in interface NodeManagersortOrder - the order in which to list the fieldsFieldList object, which is a specialized List of Field objects.NodeManager.ORDER_NONE,
NodeManager.ORDER_CREATE,
NodeManager.ORDER_EDIT,
NodeManager.ORDER_LIST,
NodeManager.ORDER_SEARCHpublic Field getField(String fieldName) throws NotFoundException
NodeManagergetField in interface NodeManagerfieldName - the name of the field to be returnedNotFoundException - is the field does not existpublic String getGUIName()
NodeManagergetGUIName in interface NodeManagerpublic String getGUIName(int plurality)
NodeManagergetGUIName in interface NodeManagerplurality - the plurality (number of objects) for which to return a description
(NodeManager.GUI_SINGULAR or NodeManager.GUI_PLURAL)public String getGUIName(int plurality, Locale locale)
NodeManagergetGUIName in interface NodeManagerplurality - the plurality (number of objects) for which to return a description
(NodeManager.GUI_SINGULAR or NodeManager.GUI_PLURAL)locale - the locale that determines the language for the GUI namepublic String getName()
NodeManagergetName in interface NodeManagerpublic String getDescription()
NodeManagergetDescription in interface NodeManagerpublic String getDescription(Locale locale)
NodeManagergetDescription in interface NodeManagerlocale - the locale that determines the language for the descriptionpublic NodeManager getParent()
NodeManagergetParent in interface NodeManagerpublic String getProperty(String name)
NodeManagergetProperty in interface NodeManagername - the name of the propertypublic Map<String,String> getProperties()
NodeManagergetProperties in interface NodeManagerpublic NodeManagerList getDescendants()
NodeManagergetDescendants in interface NodeManagerpublic Collection<Function<?>> getFunctions()
AbstractNodeNode.getNodeManager().Node.getFunctions().getFunctions in interface NodegetFunctions in class AbstractNodeFunction objects.MMBase 1.9-SNAPSHOT - ${javadoctimestamp}