MMObjectBuilder (MMBase 1.9-SNAPSHOT

java.lang.Object
- org.mmbase.util.functions.FunctionProvider
- - org.mmbase.module.core.MMTable
  - - org.mmbase.module.core.MMObjectBuilder

All Implemented Interfaces:

EventListener, NodeEventListener, RelationEventListener

Direct Known Subclasses:

AbstractServletBuilder, Actions, Contexts, Cookies, CronJobs, DayMarkers, Dummy, EmailBuilder, ExampleBuilder, Groups, InsRel, Jumpers, MediaFragments, MediaProviders, MediaSources, MMEvents, MMServers, Netfiles, NetFileSrv, OAlias, People, Properties, Ranks, RelDef, TypeDef, TypeRel, Urls, UserBuilder, Users, Users, Versions, VirtualBuilder, Vwms, Vwmtasks
```
public class MMObjectBuilder
extends MMTable
implements NodeEventListener, RelationEventListener
```
This class is the base class for all builders. It offers a list of routines which are useful in maintaining the nodes in the MMBase object cloud.
Builders are the core of the MMBase system. They create, delete and search the MMObjectNodes. Most manipulations concern nodes of that builders type. However, a number of retrieval routines extend beyond a builders scope and work on the cloud in general, allowing some ease in retrieval of nodes. The basic routines in this class can be extended to handle more specific demands for nodes. Most of these 'extended builders' will be stored in mmbase.org.builders or mmbase.org.corebuilders. Examples include relation builders or builders for handling binary data such as images. The various builders are registered by the 'TypeDef' builder class (one of the core builders, itself an extension of this class).

Version:

$Id$

Author:

Daniel Ockeloen, Rob Vermeulen, Pierre van Rooden, Eduard Witteveen, Johannes Verelst, Rob van Maris, Michiel Meeuwissen, Ernst Bunders

Field Summary

Fields
Modifier and Type	Field and Description
`static Parameter<?>[]`	`AGE_PARAMETERS` Parameters for the age function
`protected boolean`	`broadCastChanges` Determines whether changes to this builder need be broadcast to other known mmbase servers.
`static String`	`DEFAULT_ALINEA` Default replacements for method getHTML()
`static String`	`DEFAULT_EOL`
`String`	`description` Description of the builder in the currently selected language Not that the first time the builder is created, this value is what is stored in the TypeDef table.
`protected Map<String,String>`	`descriptions` Descriptions of the builder per language Can be set with the <descriptions> tag in the xml builder file.
`static int`	`EVENT_TYPE_LOCAL`
`static int`	`EVENT_TYPE_REMOTE`
`static String`	`FIELD_NUMBER` Name of the field containing the object number, which uniquely identifies the node.
`static String`	`FIELD_OBJECT_TYPE` Name of the field containing the object type number.
`static String`	`FIELD_OWNER` Name of the field containing the owner.
`protected Map<String,CoreField>`	`fields`
`protected static BlobCache`	`genericBlobCache` The cache for all blobs.
`protected Function<Collection<? extends Function>>`	`getFunctions` Every Function Provider provides least the 'getFunctions' function, which returns a Set of all functions which it provides.
`static String`	`GUI_INDICATOR` Default output when no data is available to determine a node's GUI description
`static Parameter<?>[]`	`GUI_PARAMETERS` Parameters for the GUI function
`protected Function<String>`	`guiFunction` The famous GUI function as a function object.
`protected Function<Object>`	`infoFunction` The info-function is a node-function and a builder-function.
`protected long`	`internalVersion` Internal (instance) version number of this builder.
`(package private) String`	`maintainer` Maintainer information for builder registration Set with <builder maintainer="mmbase.org" version="0"> in the xml builder file
`protected static NodeCache`	`nodeCache` The cache that contains the X last requested nodes
`protected int`	`oType` The current builder's object type Retrieved from the TypeDef builder.
`protected Map<String,String>`	`pluralNames` Collections of (GUI) names (plural) for the builder's objects, divided by language
`String`	`searchAge` The default search age for this builder.
`protected Map<String,String>`	`singularNames` Collections of (GUI) names (singular) for the builder's objects, divided by language
`static String`	`SYSTEM_OWNER` Default (system) owner name for the owner field.
`static int`	`TEMPNODE_DEFAULT_SIZE` Default size of the temporary node cache
`static Map<String,MMObjectNode>`	`temporaryNodes` Collection for temporary nodes, Used by the Temporarynodemanager when working with transactions The default size is 1024.
`static String`	`TMP_FIELD_EXISTS`
`static String`	`TMP_FIELD_NUMBER`
`(package private) static String`	`TMP_FIELD_RESOLVED`
`protected boolean`	`virtual` Determines whether a builder is virtual (data is not stored in the storage layer).
`protected static Parameter<?>[]`	`WRAP_PARAMETERS` Parameters constants for the NodeFunction `wrapFunction`.
`protected Function<String>`	`wrapFunction` This function wraps the text of a node's field and returns the result as a String.
`(package private) String`	`xmlPath` Full filename (path + buildername + ".xml") where we loaded the builder from It is relative from the '/builders/' subdir

Fields inherited from class org.mmbase.module.core.MMTable
maxNodesFromQuery, mmb, storageConnector, tableName

Fields inherited from class org.mmbase.util.functions.FunctionProvider
functions

Constructor Summary

Constructors
Constructor and Description

MMObjectBuilder()
Constructor.

Constructors
Constructor and Description
`MMObjectBuilder()` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addEventListener(EventListener listener)` simple way to register a NodeEvent listener and a RelationEventListener at the same time.
`void`	`addField(CoreField def)` Add a field to this builder.
`boolean`	`addLocalObserver(MMBaseObserver obs)` Deprecated. use the new event system as well. check out addEventListener(Object listener) or MMBase.addEventListener(EventListener listener)
`boolean`	`addRemoteObserver(MMBaseObserver obs)` Deprecated. use the new event system as well. check out addEventListener(Object listener) or MMBase.addEventListener(EventListener listener)
`boolean`	`broadcastChanges()` Determines whether changes to this builder need be broadcast to other known mmbase servers.
`boolean`	`checkAddTmpField(String field)` Defines a virtual field to use for temporary nodes.
`int`	`clearBlobCache(int nodeNumber)`
`boolean`	`commit(MMObjectNode node)` Commit changes to this node to the storage layer.
`boolean`	`create()` Creates a new builder table in the storage layer.
`boolean`	`createAlias(int number, String alias)` Creates an alias for a node, provided the OAlias builder is loaded.
`boolean`	`createAlias(int number, String alias, String owner)` Creates an alias for a node, provided the OAlias builder is loaded.
`void`	`createIfNotExists()` Creates the associated database table, unless it already exists.
`void`	`delete()` Removes the builder from the storage.
`boolean`	`equals(MMObjectNode o1, MMObjectNode o2)` Implements equals for nodes (this is in MMObjectBuilder because you cannot override MMObjectNode)
`boolean`	`equals(Object o)` Equals must be implemented because of the list of MMObjectBuilder which is used for ancestors Declared the method final, because the instanceof operator is used.
`protected Object`	`executeFunction(MMObjectNode node, String function, List<?> arguments)` Executes a function on the field of a node, and returns the result.
`protected Object`	`executeFunction(MMObjectNode node, String function, String field)` Deprecated. use `getFunction(MMObjectNode, String)`
`boolean`	`fieldLocalChanged(String number, String builder, String field, String value)` Called when a local field is changed.
`List<MMObjectBuilder>`	`getAncestors()` Gives the list of parent-builders.
`protected BlobCache`	`getBlobCache(String fieldName)` Returns
`String`	`getClassName()` Deprecated. don't use
`File`	`getConfigFile()` Deprecated. Need something as getConfigResource in stead.
`String`	`getConfigResource()`
`DataTypeCollector`	`getDataTypeCollector()` Returns the datatype collector belonging to this buidler.
`int`	`getDBState(String fieldName)` Return a field's storage state.
`int`	`getDBType(String fieldName)` Return a field's storage type.
`MMObjectNode`	`getDefaultTeaser(MMObjectNode node, MMObjectNode tnode)` Deprecated. Will be removed?
`String`	`getDefaultUrl(int src)` Return the default url of this object.
`List<MMObjectBuilder>`	`getDescendants()` Returns an (unmodifiable) list of all descendant-builders.
`String`	`getDescription()` Get description of the builder
`String`	`getDescription(String lang)` Gets description of the builder, using the specified language.
`Map<String,String>`	`getDescriptions()` Get descriptions of the builder
`MMObjectNode`	`getEmptyNode(String owner)` Returns a new empty node object.
`FieldDefs`	`getField(String fieldName)` Return a field's definition
`Set<String>`	`getFieldNames()` Return a list of field names of this table.
`Collection<CoreField>`	`getFields()` Return a copy of the list of field definitions of this table.
`List<CoreField>`	`getFields(int sortOrder)` Gets the field definitions for the editor, sorted according to the specified order, and excluding the fields that have not been assigned a valid position (valid is >= 0).
`protected Function<?>`	`getFunction(MMObjectNode node, String functionName)` Instantiates a Function object for a certain function on a certain node of this type.
`protected List<String>`	`getFunctionParameters(String fields)` Deprecated. use executeFunction(node, function, list)
`protected Collection<Function<?>>`	`getFunctions(MMObjectNode node)` Returns all Functions which are available (or at least known to be available) on a Node.
`(package private) Object`	`getFunctionValue(MMObjectNode node, String functionName, List<?> parameters)` Executes a 'function' on a MMObjectNode.
`String`	`getGUIIndicator(MMObjectNode node)` What should a GUI display for this node.
`String`	`getGUIIndicator(MMObjectNode node, Parameters pars)` A complicated default implementation for GUI.
`String`	`getGUIIndicator(String fieldName, MMObjectNode node)` What should a GUI display for this node/field combo.
`protected String`	`getHTML(String body)` Deprecated.
`String`	`getInitParameter(String name)` Retrieve a specific property.
`Map<String,String>`	`getInitParameters()` Get all builder properties
`Map<String,String>`	`getInitParameters(String contextPath)` Get all builder properties and override properties through application context
`long`	`getInternalVersion()` Returns the builder's internal version number.
`Vector<String>`	`getList(PageInfo sp, StringTagger tagger, StringTokenizer tok)` Obtains a list of string values by performing the provided command and parameters.
`protected String`	`getLocaleGUIIndicator(Locale locale, MMObjectNode node)` The GUIIndicator can depend on the locale.
`protected String`	`getLocaleGUIIndicator(Locale locale, String field, MMObjectNode node)` The GUIIndicator can depend on the locale.
`String`	`getMachineName()` Get the name of this mmserver from the MMBase Root
`String`	`getMaintainer()` Retrieves the maintainer of this builder
`MMObjectNode`	`getNewNode(String owner)` Get a new node, using this builder as its parent.
`protected MMObjectNode`	`getNewTmpNode(String owner, String key)` Create a new temporary node and put it in the temporary _exist node space
`FieldDefs`	`getNextField(String currentfield)` Deprecated. use getNextField() with sortorder ORDER_EDIT
`FieldDefs`	`getNextField(String currentfield, int sortorder)` Returns the next field as defined by its sortorder, according to the specified order.
`MMObjectNode`	`getNode(int number)` Retrieves a node based on it's number (a unique key), retrieving the node from the node cache if possible.
`MMObjectNode`	`getNode(String key)` Retrieves a node based on a unique key.
`MMObjectNode`	`getNode(String key, boolean useCache)` Retrieves a node based on a unique key.
`MMObjectNode`	`getNodeFromCache(Integer number)` Retrieves a node from the cache, or `null` if it doesn't exist.
`protected String`	`getNodeGUIIndicator(MMObjectNode node, Parameters params)` Returns a GUI-indicator for the node itself.
`int`	`getNumber()` Returns the builder object number, which also functions as the objecttype.
`int`	`getObjectType()` Returns the objecttype (otype).
`protected Object`	`getObjectValue(MMObjectNode node, String field)` Like getValue, but without the 'old' code (short_ html_ etc).
`MMObjectBuilder`	`getParentBuilder()` Returns the builder that this builder extends.
`String`	`getPluralName()` Gets long name of the builder in the current default language.
`String`	`getPluralName(String lang)` Gets long name of the builder, using the specified language.
`Map<String,String>`	`getPluralNames()` Gets a list of plural names (language - value pairs)
`Vector<MMObjectNode>`	`getRelations_main(int src)` Returns all relations of a node.
`String`	`getSearchAge()` Gets search Age
`String`	`getShort(String str, int len)` Support routine to return shorter strings.
`protected byte[]`	`getShortedByte(String fieldName, MMObjectNode node)` Deprecated. Use `getShortedInputStream(java.lang.String, org.mmbase.module.core.MMObjectNode)`
`protected InputStream`	`getShortedInputStream(String fieldName, MMObjectNode node)` Get binary data of a blob field.
`protected String`	`getShortedText(String fieldName, MMObjectNode node)` Get text from a blob field.
`String`	`getSingularName()` Gets short name of the builder in the current default language.
`String`	`getSingularName(String lang)` Gets short name of the builder, using the specified language.
`Map<String,String>`	`getSingularNames()` Gets a list of singular names (language - value pairs)
`String`	`getSmartPath(String documentRoot, String path, String nodeNumber, String version)` Deprecated. This method will be finalized in MMBase 1.9 and removed afterwards. You can implement a new smart-path for your builders, with a class like `SmartPathFunction` in stead, and configure it in your builder xml as the implementation for the 'smartpath' function. This makes extensions less dependent on precise arguments (e.g. 'documentRoot' is not relevant for 'resourceloader' implementation), and makes this function pluggable on all builders. See also MMB-1449.
`protected static MMObjectNode`	`getTmpNode(String key)` Get nodes from the temporary node space
`protected static String`	`getURLEncode(String body)` Returns a URLEncoded-version (MIME x-www-form-urlencoded) of a string.
`Object`	`getValue(MMObjectNode node, String field)` Provides additional functionality when obtaining field values.
`int`	`getVersion()` Retrieves the version of this builder
`protected static String`	`getWAP(String body)` Returns a WAP-version of a string.
`String`	`getXMLPath()` Retrieves the subpath of the builder's xml configuration file.
`boolean`	`hasField(String fieldName)`
`int`	`hashCode()`
`int`	`hashCode(MMObjectNode o)` Implements for MMObjectNode
`static String`	`hostname_function(String url)` Deprecated. Has nothing to do with mmbase nodes. Should be in org.mmbase.util
`boolean`	`init()` Initializes this builder The property 'mmb' needs to be set for the builder before this method can be called.
`int`	`insert(int oType, String owner)` Insert a new, empty, object of a certain type.
`int`	`insert(String owner, MMObjectNode node)` Insert a new object (content provided) in the cloud, including an entry for the object alias (if provided).
`boolean`	`isExtensionOf(MMObjectBuilder o)` Checks wether this builder is an extension of the argument builder
`boolean`	`isNodeCached(Integer number)` Is this node cached at this moment?
`protected boolean`	`isNull(String fieldName, MMObjectNode node)`
`boolean`	`isVirtual()` Determine whether this builder is virtual.
`void`	`loadInitParameters()` Override properties through application context
`protected Function`	`newFunctionInstance(String name, Parameter[] parameters, ReturnType returnType)`
`boolean`	`nodeLocalChanged(String machine, String number, String builder, String ctype)` Deprecated. use notify(NodeEvent) in stead
`boolean`	`nodeRemoteChanged(String machine, String number, String builder, String ctype)` Deprecated. use notify(NodeEvent) in stead
`void`	`notify(NodeEvent event)`
`void`	`notify(RelationEvent event)`
`MMObjectNode`	`preCommit(MMObjectNode node)` This method is called before an actual write to the storage layer is performed.
`boolean`	`process(PageInfo sp, StringTokenizer command, Hashtable cmds, Hashtable vars)` The hook that passes all form related pages to the correct handler.
`(package private) static void`	`putTmpNode(String key, MMObjectNode node)` Put a Node in the temporary node list
`void`	`removeEventListener(EventListener listener)`
`void`	`removeField(String fieldName)` Remove a field from this builder.
`boolean`	`removeLocalObserver(MMBaseObserver obs)`
`void`	`removeNode(MMObjectNode node)` Remove a node from the cloud.
`void`	`removeRelations(MMObjectNode node)` Remove the relations of a node.
`boolean`	`removeRemoteObserver(MMBaseObserver obs)`
`protected void`	`removeSyncNodes(MMObjectNode node)` Removes the syncnodes to this node.
`(package private) static void`	`removeTmpNode(String key)` Remove a node from the temporary node space
`String`	`replace(PageInfo sp, StringTokenizer tok)` Obtains a string value by performing the provided command.
`MMObjectNode`	`safeCache(Integer n, MMObjectNode node)` Stores a node in the cache provided the cache is not write locked.
`(package private) boolean`	`safeCommit(MMObjectNode node)` Locks the node cache during the commit of a node.
`(package private) int`	`safeInsert(MMObjectNode node, String userName)` Locks the node cache during the insert of a node.
`boolean`	`sendFieldChangeSignal(MMObjectNode node, String fieldName)` Send a signal to other servers that a field was changed.
`void`	`setDefaults(MMObjectNode node)` Sets defaults for a node.
`void`	`setDescription(String e)` Set description of the builder
`void`	`setDescriptions(Map<String,String> e)` Set descriptions of the builder
`void`	`setFields(List<CoreField> f)` Stores fields information of this table.
`void`	`setInitParameter(String name, String value)` Set a single builder property The propertie will not be saved.
`(package private) void`	`setInitParameters(Map<String,String> properties)` Set all builder properties Changed properties will not be saved.
`void`	`setMaintainer(String m)` Sets the maintainer of this builder
`(package private) void`	`setParentBuilder(MMObjectBuilder parent)` Sets the builder that this builder extends, and registers it in the storage layer.
`void`	`setPluralNames(Map<String,String> names)` Sets a list of plural names (language - value pairs)
`void`	`setSearchAge(String age)` Sets search Age.
`void`	`setSingularNames(Map<String,String> names)` Sets a list of singular names (language - value pairs)
`protected int`	`setUniqueValue(MMObjectNode node, String field, int offset)` In setDefault you could want to generate unique values for fields (if the field is 'unique').
`protected String`	`setUniqueValue(MMObjectNode node, String field, String baseValue)` In setDefault you could want to generate unique values for fields (if the field is 'unique').
`boolean`	`setValue(MMObjectNode node, String fieldName)` Provides additional functionality when setting field values.
`boolean`	`setValue(MMObjectNode node, String fieldName, Object originalValue)` Sets a key/value pair in the main values of this node.
`void`	`setVersion(int i)` Sets the version of this builder
`void`	`setXMLPath(String m)` Sets the subpath of the builder's xml configuration file.
`void`	`shutdown()` clean all acquired resources, because system is shutting down
`void`	`testValidData(MMObjectNode node)` Tests whether the data in a node is valid (throws an exception if this is not the case).
`String`	`toString()` Implmenting a sensible toString is usefull for debugging.
`String`	`toString(MMObjectNode n)` Implements for MMObjectNode
`protected void`	`update()` Updates the internal version number of this buidler;
`protected void`	`updateFields()` Clears all field list caches, and recalculates the field list.
`static String`	`wrap(String text, int width)` Wraps a string.

Methods inherited from class org.mmbase.module.core.MMTable
count, count, created, getFullTableName, getMMBase, getNode, getNodes, getNodes, getNodes, getNodeType, getStorageConnector, getTableName, search, searchVector, setMMBase, setTableName, size

Methods inherited from class org.mmbase.util.functions.FunctionProvider
addFunction, createParameters, getFunction, getFunctions, getFunctionValue

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - FIELD_NUMBER
```
public static final String FIELD_NUMBER
```
    Name of the field containing the object number, which uniquely identifies the node.
    
    Since:
    
    MMBase-1.8
    
    See Also:
    
    Constant Field Values
  - FIELD_OWNER
```
public static final String FIELD_OWNER
```
    Name of the field containing the owner. The owner field is used for security implementations.
    
    Since:
    
    MMBase-1.8
    
    See Also:
    
    Constant Field Values
  - FIELD_OBJECT_TYPE
```
public static final String FIELD_OBJECT_TYPE
```
    Name of the field containing the object type number. This refers to an entry in the 'typedef' builder table.
    
    Since:
    
    MMBase-1.8
    
    See Also:
    
    Constant Field Values
  - TMP_FIELD_NUMBER
```
public static final String TMP_FIELD_NUMBER
```
    Since:
    
    MMBase-1.8
    
    See Also:
    
    Constant Field Values
  - TMP_FIELD_EXISTS
```
public static final String TMP_FIELD_EXISTS
```
    See Also:
    
    Constant Field Values
  - TMP_FIELD_RESOLVED
```
static final String TMP_FIELD_RESOLVED
```
    Since:
    
    MMBase-1.9.1
    
    See Also:
    
    Constant Field Values
  - SYSTEM_OWNER
```
public static final String SYSTEM_OWNER
```
    Default (system) owner name for the owner field.
    
    Since:
    
    MMBase-1.8
    
    See Also:
    
    Constant Field Values
  - TEMPNODE_DEFAULT_SIZE
```
public static final int TEMPNODE_DEFAULT_SIZE
```
    Default size of the temporary node cache
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ALINEA
```
public static final String DEFAULT_ALINEA
```
    Default replacements for method getHTML()
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EOL
```
public static final String DEFAULT_EOL
```
    See Also:
    
    Constant Field Values
  - EVENT_TYPE_LOCAL
```
public static final int EVENT_TYPE_LOCAL
```
    See Also:
    
    Constant Field Values
  - EVENT_TYPE_REMOTE
```
public static final int EVENT_TYPE_REMOTE
```
    See Also:
    
    Constant Field Values
  - AGE_PARAMETERS
```
public static final Parameter<?>[] AGE_PARAMETERS
```
    Parameters for the age function
    
    Since:
    
    MMBase-1.7
  - temporaryNodes
```
public static Map<String,MMObjectNode> temporaryNodes
```
    Collection for temporary nodes, Used by the Temporarynodemanager when working with transactions The default size is 1024.
    
    Duplicate:
    
    use Cache object instead
    
    Scope:
    
    protected
  - GUI_INDICATOR
```
public static final String GUI_INDICATOR
```
    Default output when no data is available to determine a node's GUI description
    
    See Also:
    
    Constant Field Values
  - genericBlobCache
```
protected static final BlobCache genericBlobCache
```
    The cache for all blobs.
    
    Since:
    
    1.8.0
  - nodeCache
```
protected static final NodeCache nodeCache
```
    The cache that contains the X last requested nodes
  - description
```
public String description
```
    Description of the builder in the currently selected language Not that the first time the builder is created, this value is what is stored in the TypeDef table.
    
    Scope:
    
    protected
  - descriptions
```
protected Map<String,String> descriptions
```
    Descriptions of the builder per language Can be set with the <descriptions> tag in the xml builder file.
  - searchAge
```
public String searchAge
```
    The default search age for this builder. Used for intializing editor search forms (see HtmlBase) Default value is 31. Can be changed with the <searchage> tag in the xml builder file.
    
    Scope:
    
    protected
  - broadCastChanges
```
protected boolean broadCastChanges
```
    Determines whether changes to this builder need be broadcast to other known mmbase servers.
  - internalVersion
```
protected long internalVersion
```
    Internal (instance) version number of this builder.
  - oType
```
protected int oType
```
    The current builder's object type Retrieved from the TypeDef builder.
  - maintainer
```
String maintainer
```
    Maintainer information for builder registration Set with <builder maintainer="mmbase.org" version="0"> in the xml builder file
    
    Scope:
    
    protected
  - singularNames
```
protected Map<String,String> singularNames
```
    Collections of (GUI) names (singular) for the builder's objects, divided by language
  - pluralNames
```
protected Map<String,String> pluralNames
```
    Collections of (GUI) names (plural) for the builder's objects, divided by language
  - xmlPath
```
String xmlPath
```
    Full filename (path + buildername + ".xml") where we loaded the builder from It is relative from the '/builders/' subdir
    
    Scope:
    
    protected
  - GUI_PARAMETERS
```
public static final Parameter<?>[] GUI_PARAMETERS
```
    Parameters for the GUI function
    
    Since:
    
    MMBase-1.7
  - guiFunction
```
protected Function<String> guiFunction
```
    The famous GUI function as a function object.
    
    Since:
    
    MMBase-1.8
  - WRAP_PARAMETERS
```
protected static final Parameter<?>[] WRAP_PARAMETERS
```
    Parameters constants for the NodeFunction wrapFunction.
    
    Since:
    
    MMBase-1.8
  - wrapFunction
```
protected Function<String> wrapFunction
```
    This function wraps the text of a node's field and returns the result as a String. It takes as parameters a fieldname, the line length to wrap, and the Node containing the data. This function can be called through the function framework.
    
    Since:
    
    MMBase-1.8
  - getFunctions
```
protected Function<Collection<? extends Function>> getFunctions
```
    Every Function Provider provides least the 'getFunctions' function, which returns a Set of all functions which it provides. This is overridden from FunctionProvider, because this one needs to be (also) a NodeFunction
    
    Since:
    
    MMBase-1.8
  - infoFunction
```
protected Function<Object> infoFunction
```
    The info-function is a node-function and a builder-function. Therefore it is defined as a node-function, but also overidesd getFunctionValue(Parameters).
    
    Since:
    
    MMBase-1.8
  - fields
```
protected final Map<String,CoreField> fields
```
  - virtual
```
protected boolean virtual
```
    Determines whether a builder is virtual (data is not stored in the storage layer).
- Constructor Detail
  - MMObjectBuilder
```
public MMObjectBuilder()
```
    Constructor.
- Method Detail
  - init
```
public boolean init()
```
    Initializes this builder The property 'mmb' needs to be set for the builder before this method can be called. The method retrieves data from the TypeDef builder, or adds data to that builder if the current builder is not yet registered.
    
    Returns:
    
    true if init was completed, false if uncompleted.
    
    See Also:
    
    create()
  - createIfNotExists
```
public void createIfNotExists()
```
    Creates the associated database table, unless it already exists. You can call this method from init() if you want to use the table already then. This is only possible if there are not dependencies on other builders which might not yet be initalized (MMB-1991).
    
    Since:
    
    MMBase-1.9.5
  - shutdown
```
public void shutdown()
```
    clean all acquired resources, because system is shutting down
  - getNumber
```
public int getNumber()
```
    Returns the builder object number, which also functions as the objecttype. This is the same value as the value of the 'otype' field of objects created by this builder (rather than created by its descendants).
    
    Returns:
    
    the builder number
    
    Since:
    
    MMBase-1.8
  - getObjectType
```
public int getObjectType()
```
    Returns the objecttype (otype). By preference, use getNumber() for future compatibility with the bridge NodeManager methods.
    
    Returns:
    
    the objecttype
  - update
```
protected void update()
```
    Updates the internal version number of this buidler;
  - getInternalVersion
```
public long getInternalVersion()
```
    Returns the builder's internal version number. This number can be used to sync wrapper classes. I.e. to make sure that a nodemanager's fieldlist is the same as that of the wrapped builder.
  - create
```
public boolean create()
```
    Creates a new builder table in the storage layer.
  - delete
```
public void delete()
```
    Removes the builder from the storage.
    
    Since:
    
    MMBase-1.7
  - testValidData
```
public void testValidData(MMObjectNode node)
                   throws InvalidDataException
```
    Tests whether the data in a node is valid (throws an exception if this is not the case).
    
    Parameters:
    
    node - The node whose data to check
    
    Throws:
    
    InvalidDataException - If the data was unrecoverably invalid (the references did not point to existing objects)
  - insert
```
public int insert(int oType,
                  String owner)
```
    Insert a new, empty, object of a certain type.
    
    Parameters:
    
    oType - The type of object to create
    
    owner - The administrator creating the node
    
    Returns:
    
    An int value which is the new object's unique number, -1 if the insert failed. The basic routine does not create any nodes this way and always fails.
  - insert
```
public int insert(String owner,
                  MMObjectNode node)
```
    Insert a new object (content provided) in the cloud, including an entry for the object alias (if provided). This method indirectly calls preCommit(org.mmbase.module.core.MMObjectNode).
    
    Parameters:
    
    owner - The administrator creating the node
    
    node - The object to insert. The object need be of the same type as the current builder.
    
    Returns:
    
    An int value which is the new object's unique number, -1 if the insert failed.
  - preCommit
```
public MMObjectNode preCommit(MMObjectNode node)
```
    This method is called before an actual write to the storage layer is performed.
    
    Parameters:
    
    node - The node to be committed.
    
    Returns:
    
    the node to be committed (possibly after changes have been made).
  - commit
```
public boolean commit(MMObjectNode node)
```
    Commit changes to this node to the storage layer. This method indirectly calls preCommit(org.mmbase.module.core.MMObjectNode). Use only to commit changes - for adding node, use insert(int, java.lang.String).
    
    Parameters:
    
    node - The node to be committed
    
    Returns:
    
    true if commit successful
  - broadcastChanges
```
public boolean broadcastChanges()
```
    Determines whether changes to this builder need be broadcast to other known mmbase servers. This setting also governs whether the cache for relation builders is emptied when a relation changes. Actual broadcasting (and cache emptying) is initiated in the storage layer, when changes are commited. By default, all builders broadcast their changes, with the exception of the TypeDef builder. MM: Can somebody please explain _why_ typedef node changes, like e.g. creating a new node type are _not_ broadcast.
    
    Since:
    
    MMBase-1.8
  - createAlias
```
public boolean createAlias(int number,
                           String alias,
                           String owner)
```
    Creates an alias for a node, provided the OAlias builder is loaded.
    
    Parameters:
    
    number - the to-be-aliased node's unique number
    
    alias - the aliasname to associate with the object
    
    owner - the owner of the alias
    
    Returns:
    
    if the alias could be created
    
    Since:
    
    MMBase-1.8
  - createAlias
```
public boolean createAlias(int number,
                           String alias)
```
    Creates an alias for a node, provided the OAlias builder is loaded.
    
    Parameters:
    
    number - the to-be-aliased node's unique number
    
    alias - the aliasname to associate with the object
    
    Returns:
    
    if the alias could be created
  - getParentBuilder
```
public MMObjectBuilder getParentBuilder()
```
    Returns the builder that this builder extends.
    
    Returns:
    
    the extended (parent) builder, or null if not available
    
    Since:
    
    MMBase-1.6
  - getAncestors
```
public List<MMObjectBuilder> getAncestors()
```
    Gives the list of parent-builders.
    
    Since:
    
    MMBase-1.6.2
  - getDescendants
```
public List<MMObjectBuilder> getDescendants()
```
    Returns an (unmodifiable) list of all descendant-builders.
    
    Since:
    
    MMBase-1.6.2
  - setParentBuilder
```
void setParentBuilder(MMObjectBuilder parent)
```
    Sets the builder that this builder extends, and registers it in the storage layer.
    
    Parameters:
    
    parent - the extended (parent) builder, or null if not available
    
    Since:
    
    MMBase-1.6
  - getDataTypeCollector
```
public DataTypeCollector getDataTypeCollector()
```
    Returns the datatype collector belonging to this buidler. A datatype collector contains the datatypes that are local to this builder.
    
    Since:
    
    MMBase-1.8
  - isExtensionOf
```
public boolean isExtensionOf(MMObjectBuilder o)
```
    Checks wether this builder is an extension of the argument builder
    
    Since:
    
    MMBase-1.6.2
  - getNewNode
```
public MMObjectNode getNewNode(String owner)
```
    Get a new node, using this builder as its parent. The new node is not a part of the cloud yet, and thus has the value -1 as a number. (Call insert(int, java.lang.String) to add the node to the cloud).
    
    Parameters:
    
    owner - The administrator creating the new node.
    
    Returns:
    
    A newly initialized MMObjectNode.
  - getEmptyNode
```
public MMObjectNode getEmptyNode(String owner)
```
    Returns a new empty node object. This is used by Storage to create a non-new node object (isNew is false), which is then be filled with actual values from storage.
    
    Since:
    
    MMBase-1.8.
  - setDefaults
```
public void setDefaults(MMObjectNode node)
```
    Sets defaults for a node. Fields "number", "owner" and "otype", 'node' typed fields and virtual fields are not set by this method.
    
    Parameters:
    
    node - The node to set the defaults of.
  - setUniqueValue
```
protected String setUniqueValue(MMObjectNode node,
                                String field,
                                String baseValue)
```
    In setDefault you could want to generate unique values for fields (if the field is 'unique').
    
    Since:
    
    MMBase-1.7
  - setUniqueValue
```
protected int setUniqueValue(MMObjectNode node,
                             String field,
                             int offset)
```
    In setDefault you could want to generate unique values for fields (if the field is 'unique').
    
    Since:
    
    MMBase-1.7
  - removeNode
```
public void removeNode(MMObjectNode node)
```
    Remove a node from the cloud.
    
    Parameters:
    
    node - The node to remove.
  - removeSyncNodes
```
protected void removeSyncNodes(MMObjectNode node)
```
    Removes the syncnodes to this node. This is logical, but also needed to maintain storage integrety.
    
    Since:
    
    MMBase-1.7
  - removeRelations
```
public void removeRelations(MMObjectNode node)
```
    Remove the relations of a node.
    
    Parameters:
    
    node - The node whose relations to remove.
  - isNodeCached
```
public boolean isNodeCached(Integer number)
```
    Is this node cached at this moment?
    
    Parameters:
    
    number - The number of the node to check.
    
    Returns:
    
    true if the node is in the cache, false otherwise
  - getNodeFromCache
```
public MMObjectNode getNodeFromCache(Integer number)
```
    Retrieves a node from the cache, or null if it doesn't exist.
    
    Parameters:
    
    number - The number of the node to retrieve.
    
    Returns:
    
    an MMObjectNode or null if the node is not in the cache
    
    Since:
    
    MMBase-1.8
    
    To Do:
    
    This is a simple wrapper around node cache, why not expose node cache in stead?
  - safeCache
```
public MMObjectNode safeCache(Integer n,
                              MMObjectNode node)
```
    Stores a node in the cache provided the cache is not write locked.
    
    Returns:
    
    a valid node. If the node already was in the cache, the cached node is returned. In that case the node given as parameter should become invalid
  - safeCommit
```
boolean safeCommit(MMObjectNode node)
```
    Locks the node cache during the commit of a node. This prevents the cache from gaining an invalid state during the commit. Basicly the goals is to ensure that nothing is put into the cache during a commit of a node, because that may be the wrong node then.
  - safeInsert
```
int safeInsert(MMObjectNode node,
               String userName)
```
    Locks the node cache during the insert of a node. This prevents the cache from adding the node, which means that the next time the node is read it is 'refreshed' from the storage
  - isVirtual
```
public boolean isVirtual()
```
    Determine whether this builder is virtual. A virtual builder represents nodes that are not stored or retrieved directly from storage, but are created as needed.
    
    Returns:
    
    true if the builder is virtual.
  - getNode
```
public MMObjectNode getNode(String key,
                            boolean useCache)
```
    Retrieves a node based on a unique key. The key is either an entry from the OAlias table or the string-form of an integer value (the number field of an object node). Note that the OAlias builder needs to be active for the alias to be used (otherwise using an alias is concidered invalid).
    
    Parameters:
    
    key - The value to search for
    
    useCache - If true, the node is retrieved from the node cache if possible.
    
    Returns:
    
    null if the node does not exist or the key is invalid, or a MMObjectNode containing the contents of the requested node.
  - getNode
```
public MMObjectNode getNode(String key)
```
    Retrieves a node based on a unique key. The key is either an entry from the OAlias table or the string-form of an integer value (the number field of an object node). Retrieves a node from the node cache if possible.
    
    Parameters:
    
    key - The value to search for
    
    Returns:
    
    null if the node does not exist or the key is invalid, or a MMObjectNode containing the contents of the requested node.
  - getNode
```
public MMObjectNode getNode(int number)
```
    Retrieves a node based on it's number (a unique key), retrieving the node from the node cache if possible.
    
    Parameters:
    
    number - The number of the node to search for
    
    Returns:
    
    null if the node does not exist or the key is invalid, or a MMObjectNode containign the contents of the requested node.
  - getNewTmpNode
```
protected MMObjectNode getNewTmpNode(String owner,
                                     String key)
```
    Create a new temporary node and put it in the temporary _exist node space
  - putTmpNode
```
static void putTmpNode(String key,
                       MMObjectNode node)
```
    Put a Node in the temporary node list
    
    Parameters:
    
    key - The (temporary) key under which to store the node
    
    node - The node to store
  - checkAddTmpField
```
public boolean checkAddTmpField(String field)
```
    Defines a virtual field to use for temporary nodes. If the given field-name does not start with underscore ('_'), wich it usually does, then the field does also get a 'dbpos' (1000) as if it was actually present in the builder's XML as a virtual field (this is accompanied with a log message). Normally this is used to add 'tmp' fields like _number, _exists and _snumber which are system fields which are normally invisible.
    
    Parameters:
    
    field - the name of the temporary field
    
    Returns:
    
    true if the field was added, false if it already existed.
  - getTmpNode
```
protected static MMObjectNode getTmpNode(String key)
```
    Get nodes from the temporary node space
    
    Parameters:
    
    key - The (temporary) key to use under which the node is stored
  - removeTmpNode
```
static void removeTmpNode(String key)
```
    Remove a node from the temporary node space
    
    Parameters:
    
    key - The (temporary) key under which the node is stored
  - getFields
```
public Collection<CoreField> getFields()
```
    Return a copy of the list of field definitions of this table.
    
    Returns:
    
    An unmodifiable Collection with the tables fields
  - getFieldNames
```
public Set<String> getFieldNames()
```
    Return a list of field names of this table.
    
    Returns:
    
    a unmodifiable Set with the tables field names
    
    To Do:
    
    return an unmodifiable Set.
  - getField
```
public FieldDefs getField(String fieldName)
```
    Return a field's definition
    
    Parameters:
    
    fieldName - the requested field's name
    
    Returns:
    
    a FieldDefs belonging with the indicated field
    
    To Do:
    
    Should return CoreField
  - hasField
```
public boolean hasField(String fieldName)
```
    Since:
    
    MMBase-1.8
  - updateFields
```
protected void updateFields()
```
    Clears all field list caches, and recalculates the field list.
  - addField
```
public void addField(CoreField def)
```
    Add a field to this builder. This does not affect the builder config file, nor the table used.
    
    Parameters:
    
    def - the field definiton to add
  - removeField
```
public void removeField(String fieldName)
```
    Remove a field from this builder. This does not affect the builder config file, nor the table used.
    
    Parameters:
    
    fieldName - the name of the field to remove
  - getDBType
```
public int getDBType(String fieldName)
```
    Return a field's storage type. The returned value is one of the following values declared in Field: TYPE_STRING, TYPE_INTEGER, TYPE_BINARY, TYPE_FLOAT, TYPE_DOUBLE, TYPE_LONG, TYPE_NODE, TYPE_UNKNOWN
    
    Parameters:
    
    fieldName - the requested field's name
    
    Returns:
    
    the field's type.
  - getDBState
```
public int getDBState(String fieldName)
```
    Return a field's storage state. The returned value is one of the following values declared in Field: STATE_VIRTUAL, STATE_PERSISTENT, STATE_SYSTEM, STATE_UNKNOWN
    
    Parameters:
    
    fieldName - the requested field's name
    
    Returns:
    
    the field's state.
  - getGUIIndicator
```
public String getGUIIndicator(MMObjectNode node,
                              Parameters pars)
```
    A complicated default implementation for GUI.
    
    Since:
    
    MMBase-1.8
  - getNodeGUIIndicator
```
protected String getNodeGUIIndicator(MMObjectNode node,
                                     Parameters params)
```
    Returns a GUI-indicator for the node itself.
    
    Since:
    
    MMBase-1.8.2
  - getGUIIndicator
```
public String getGUIIndicator(MMObjectNode node)
```
    What should a GUI display for this node. Default the value returned is GUI_INDICATOR ('no info'). Override this to display your own choice (see Images.java). You may want to override getNodeGUIIndicator(org.mmbase.module.core.MMObjectNode, org.mmbase.util.functions.Parameters) for more flexibility.
    
    Parameters:
    
    node - The node to display
    
    Returns:
    
    the display of the node as a String
  - getGUIIndicator
```
public String getGUIIndicator(String fieldName,
                              MMObjectNode node)
```
    What should a GUI display for this node/field combo. Default is null (indicating to display the field as is) Override this to display your own choice.
    
    Parameters:
    
    node - The node to display
    
    fieldName - the name field of the field to display
    
    Returns:
    
    the display of the node's field as a String, null if not specified
  - getLocaleGUIIndicator
```
protected String getLocaleGUIIndicator(Locale locale,
                                       String field,
                                       MMObjectNode node)
```
    The GUIIndicator can depend on the locale. Override this function
    
    Since:
    
    MMBase-1.6
  - getLocaleGUIIndicator
```
protected String getLocaleGUIIndicator(Locale locale,
                                       MMObjectNode node)
```
    The GUIIndicator can depend on the locale. Override this function You may want to override getNodeGUIIndicator(org.mmbase.module.core.MMObjectNode, org.mmbase.util.functions.Parameters) for more flexibility.
    
    Since:
    
    MMBase-1.6
  - getFields
```
public List<CoreField> getFields(int sortOrder)
```
    Gets the field definitions for the editor, sorted according to the specified order, and excluding the fields that have not been assigned a valid position (valid is >= 0). This method makes an explicit sort (it does not use a cached list).
    
    Parameters:
    
    sortOrder - One of the sortorders defined in CoreField
    
    Returns:
    
    The ordered list of field definitions.
  - getNextField
```
public FieldDefs getNextField(String currentfield,
                              int sortorder)
```
    Returns the next field as defined by its sortorder, according to the specified order.
  - getNextField
```
public FieldDefs getNextField(String currentfield)
```
    Deprecated. use getNextField() with sortorder ORDER_EDIT
    
    Returns the next field as defined by its sortorder, according to it's GUIPos property (as set in the builder xml file). Used for moving between fields in an edit-form.
  - getBlobCache
```
protected BlobCache getBlobCache(String fieldName)
```
    Returns
    
    Since:
    
    MMBase-1.7.4
  - clearBlobCache
```
public int clearBlobCache(int nodeNumber)
```
    Since:
    
    MMBase-1.8
  - getValue
```
public Object getValue(MMObjectNode node,
                       String field)
```
    Provides additional functionality when obtaining field values. This method is called whenever a Node of the builder's type fails at evaluating a getValue() request (generally when a fieldname is supplied that doesn't exist). It allows the system to add 'functions' to be included with a field name, such as 'html(body)' or 'time(lastmodified)'. This method will parse the fieldname, determining functions and calling the executeFunction(org.mmbase.module.core.MMObjectNode, java.lang.String, java.util.List<?>) method to handle it. Functions in fieldnames can be given in the format 'functionname(fieldname)'. An old format allows 'functionname_fieldname' instead, though this only applies to the text functions 'short', 'html', and 'wap'. Functions can be nested, i.e. 'html(shorted(body))'. Derived builders should override this method only if they want to provide virtual fieldnames. To provide additonal functions, call FunctionProvider.addFunction(org.mmbase.util.functions.Function<?>) instead. See also the source code for ExampleBuilder.
    
    Parameters:
    
    node - the node whos efields are queries
    
    field - the fieldname that is requested
    
    Returns:
    
    the result of the 'function', or null if no valid functions could be determined.
  - getObjectValue
```
protected Object getObjectValue(MMObjectNode node,
                                String field)
```
    Like getValue, but without the 'old' code (short_ html_ etc). This is for protected use, when you are sure this is not used, and you can avoid the overhead.
    
    Since:
    
    MMBase-1.6
    
    See Also:
    
    getValue(org.mmbase.module.core.MMObjectNode, java.lang.String)
  - getFunctionParameters
```
protected List<String> getFunctionParameters(String fields)
```
    Deprecated. use executeFunction(node, function, list)
    
    Parses string containing function parameters. The parameters must be separated by ',' or ';' and may be functions themselves (i.e. a functionname, followed by a parameter list between parenthesis).
    
    Parameters:
    
    fields - The string, containing function parameters.
    
    Returns:
    
    List of function parameters (may be functions themselves).
  - getFunctionValue
```
final Object getFunctionValue(MMObjectNode node,
                              String functionName,
                              List<?> parameters)
```
    Executes a 'function' on a MMObjectNode. The function is identified by a string, and its arguments are passed by a List. The function 'info' should exist, and this will return a Map with descriptions of the possible functions. Call FunctionProvider.addFunction(org.mmbase.util.functions.Function<?>) in your extension if you want to add functions.
    
    Parameters:
    
    node - The node on which the function must be executed
    
    functionName - The string identifying the funcion
    
    parameters - The list with function argument or null (which means 'no arguments')
    
    Since:
    
    MMBase-1.6
    
    See Also:
    
    executeFunction(org.mmbase.module.core.MMObjectNode, java.lang.String, java.util.List<?>)
  - getFunction
```
protected Function<?> getFunction(MMObjectNode node,
                                  String functionName)
```
    Instantiates a Function object for a certain function on a certain node of this type.
    
    Parameters:
    
    node - The Node for on which the function must work
    
    functionName - Name of the request function.
    
    Returns:
    
    a Function object or null if no such function.
    
    Since:
    
    MMBase-1.8
  - getFunctions
```
protected Collection<Function<?>> getFunctions(MMObjectNode node)
```
    Returns all Functions which are available (or at least known to be available) on a Node.
    
    Since:
    
    MMBase-1.8
  - newFunctionInstance
```
protected Function newFunctionInstance(String name,
                                       Parameter[] parameters,
                                       ReturnType returnType)
```
    Overrides:
    
    newFunctionInstance in class FunctionProvider
    
    Since:
    
    MMBase-1.8
  - executeFunction
```
protected Object executeFunction(MMObjectNode node,
                                 String function,
                                 List<?> arguments)
```
    Executes a function on the field of a node, and returns the result. This method is called by the builder's getValue(org.mmbase.module.core.MMObjectNode, java.lang.String) method. Derived builders should override this method to provide additional functions.
    
    Throws:
    
    IllegalArgumentException - if the argument List does not fit the function
    
    Since:
    
    MMBase-1.6
    
    See Also:
    
    executeFunction(org.mmbase.module.core.MMObjectNode, java.lang.String, java.util.List<?>)
  - executeFunction
```
protected Object executeFunction(MMObjectNode node,
                                 String function,
                                 String field)
```
    Deprecated. use getFunction(MMObjectNode, String)
    
    Executes a function on the field of a node, and returns the result. This method is called by the builder's getValue(org.mmbase.module.core.MMObjectNode, java.lang.String) method. current functions are:
    on dates: date, time, timesec, longmonth, month, monthnumber, weekday, shortday, day, yearhort year
    on text: wap, html, shorted, uppercase, lowercase
    on node: age()
    on numbers: wrap_<int>, currency_euro
    
    Parameters:
    
    node - the node whose fields are queries
    
    field - the fieldname that is requested
    
    Returns:
    
    the result of the 'function', or null if no valid functions could be determined.
  - getRelations_main
```
public Vector<MMObjectNode> getRelations_main(int src)
```
    Returns all relations of a node. This returns the relation objects, not the objects related to. Note that the relations returned are always of builder type 'InsRel', even if they are really from a derived builser such as AuthRel.
    
    Parameters:
    
    src - the number of the node to obtain the relations from
    
    Returns:
    
    a Vector with InsRel nodes
    
    To Do:
    
    Return-type and name of this function are not sound.
  - getDefaultUrl
```
public String getDefaultUrl(int src)
```
    Return the default url of this object. The basic value returned is null.
    
    Parameters:
    
    src - the number of the node to obtain the url from
    
    Returns:
    
    the basic url as a String, or null if unknown.
  - getSmartPath
```
public final String getSmartPath(String documentRoot,
                                 String path,
                                 String nodeNumber,
                                 String version)
```
    Deprecated. This method will be finalized in MMBase 1.9 and removed afterwards. You can implement a new smart-path for your builders, with a class like SmartPathFunction in stead, and configure it in your builder xml as the implementation for the 'smartpath' function. This makes extensions less dependent on precise arguments (e.g. 'documentRoot' is not relevant for 'resourceloader' implementation), and makes this function pluggable on all builders. See also MMB-1449.
  - getMachineName
```
public String getMachineName()
```
    Get the name of this mmserver from the MMBase Root
    
    Returns:
    
    a String which is the server's name
  - nodeRemoteChanged
```
public boolean nodeRemoteChanged(String machine,
                                 String number,
                                 String builder,
                                 String ctype)
```
    Deprecated. use notify(NodeEvent) in stead
    
    Called when a remote node is changed. Should be called by subclasses if they override it.
    
    Parameters:
    
    machine - Name of the machine that changed the node.
    
    number - Number of the changed node as a String
    
    builder - type of the changed node
    
    ctype - command type, 'c'=changed, 'd'=deleted', 'r'=relations changed, 'n'=new
    
    Returns:
    
    always true
  - nodeLocalChanged
```
public boolean nodeLocalChanged(String machine,
                                String number,
                                String builder,
                                String ctype)
```
    Deprecated. use notify(NodeEvent) in stead
    
    Called when a local node is changed. Should be called by subclasses if they override it.
    
    Parameters:
    
    machine - Name of the machine that changed the node.
    
    number - Number of the changed node as a String
    
    builder - type of the changed node
    
    ctype - command type, 'c'=changed, 'd'=deleted', 'r'=relations changed, 'n'=new
    
    Returns:
    
    always true
  - fieldLocalChanged
```
public boolean fieldLocalChanged(String number,
                                 String builder,
                                 String field,
                                 String value)
```
    Called when a local field is changed.
    
    Parameters:
    
    number - Number of the changed node as a String
    
    builder - type of the changed node
    
    field - name of the changed field
    
    value - value it changed to
    
    Returns:
    
    always true
  - addRemoteObserver
```
public boolean addRemoteObserver(MMBaseObserver obs)
```
    Deprecated. use the new event system as well. check out addEventListener(Object listener) or MMBase.addEventListener(EventListener listener)
    
    Adds a remote observer to this builder. The observer is notified whenever an object of this builder is changed, added, or removed.
    
    Returns:
    
    always true
  - addLocalObserver
```
public boolean addLocalObserver(MMBaseObserver obs)
```
    Deprecated. use the new event system as well. check out addEventListener(Object listener) or MMBase.addEventListener(EventListener listener)
    
    Adds a local observer to this builder. The observer is notified whenever an object of this builder is changed, added, or removed.
    
    Returns:
    
    always true
  - removeLocalObserver
```
public boolean removeLocalObserver(MMBaseObserver obs)
```
    Since:
    
    MMBase-1.8
  - removeRemoteObserver
```
public boolean removeRemoteObserver(MMBaseObserver obs)
```
    Since:
    
    MMBase-1.8
  - getDefaultTeaser
```
public MMObjectNode getDefaultTeaser(MMObjectNode node,
                                     MMObjectNode tnode)
```
    Deprecated. Will be removed?
    
    Used to create a default teaser by any builder
  - getList
```
public Vector<String> getList(PageInfo sp,
                              StringTagger tagger,
                              StringTokenizer tok)
```
    Obtains a list of string values by performing the provided command and parameters. This method is SCAN related and may fail if called outside the context of the SCAN servlet.
    
    Parameters:
    
    sp - The PageInfo (containing http and user info) that calls the function
    
    tagger - a Hashtable of parameters (name-value pairs) for the command
    
    tok - a list of strings that describe the (sub)command to execute
    
    Returns:
    
    a Vector containing the result values as a String
  - replace
```
public String replace(PageInfo sp,
                      StringTokenizer tok)
```
    Obtains a string value by performing the provided command. The command can be called:
    - by SCAN : $MOD-MMBASE-BUILDER-[buildername]-[command]
    - in jsp : cloud.getNodeManager(buildername).getInfo(command);
    Parameters:
    
    sp - The PageInfo (containing http and user info) that calls the function
    
    tok - a list of strings that describe the (sub)command to execute
    
    Returns:
    
    the result value as a String
  - process
```
public boolean process(PageInfo sp,
                       StringTokenizer command,
                       Hashtable cmds,
                       Hashtable vars)
```
    The hook that passes all form related pages to the correct handler. This method is SCAN related and may fail if called outside the context of the SCAN servlet. The methood is currentkly called by the MMEDIT module, whenever a 'PRC-CMD-BUILDER-...' command is encountered in the list of commands to be processed.
    
    Parameters:
    
    sp - The PageInfo (containing http and user info) that calls the function
    
    command - a list of strings that describe the (sub)command to execute (the portion after ' PRC-CMD-BUILDER')
    
    cmds - the commands (PRC-CMD) that are iurrently being processed, including the current command.
    
    vars - variables (PRC-VAR) thatw ere set to be used during processing.
    
    Returns:
    
    the result value as a String
  - setDescription
```
public void setDescription(String e)
```
    Set description of the builder
    
    Parameters:
    
    e - the description text
  - setDescriptions
```
public void setDescriptions(Map<String,String> e)
```
    Set descriptions of the builder
    
    Parameters:
    
    e - a Map containing the descriptions
  - getDescription
```
public String getDescription()
```
    Get description of the builder
    
    Returns:
    
    the description text
  - getDescription
```
public String getDescription(String lang)
```
    Gets description of the builder, using the specified language.
    
    Parameters:
    
    lang - The language requested
    
    Returns:
    
    the descriptions in that language, or null if it is not avaialble
  - getDescriptions
```
public Map<String,String> getDescriptions()
```
    Get descriptions of the builder
    
    Returns:
    
    a Map containing the descriptions
  - setSearchAge
```
public void setSearchAge(String age)
```
    Sets search Age.
    
    Parameters:
    
    age - the search age as a String
  - getSearchAge
```
public String getSearchAge()
```
    Gets search Age
    
    Returns:
    
    the search age as a String
  - getSingularName
```
public String getSingularName(String lang)
```
    Gets short name of the builder, using the specified language.
    
    Parameters:
    
    lang - The language requested
    
    Returns:
    
    the short name in that language, or null if it is not available
  - getSingularName
```
public String getSingularName()
```
    Gets short name of the builder in the current default language. If the current language is not available, the "en" version is returned instead. If that name is not available, the internal builder name (table name) is returned.
    
    Returns:
    
    the short name in either the default language or in "en"
  - getPluralName
```
public String getPluralName(String lang)
```
    Gets long name of the builder, using the specified language.
    
    Parameters:
    
    lang - The language requested
    
    Returns:
    
    the long name in that language, or null if it is not available
  - getPluralName
```
public String getPluralName()
```
    Gets long name of the builder in the current default language. If the current language is not available, the "en" version is returned instead. If that name is not available, the singular name is returned.
    
    Returns:
    
    the long name in either the default language or in "en"
  - getClassName
```
public String getClassName()
```
    Deprecated. don't use
    
    Returns the classname of this builder
  - sendFieldChangeSignal
```
public boolean sendFieldChangeSignal(MMObjectNode node,
                                     String fieldName)
```
    Send a signal to other servers that a field was changed.
    
    Parameters:
    
    node - the node the field was changed in
    
    fieldName - the name of the field that was changed
    
    Returns:
    
    always true
  - setSingularNames
```
public void setSingularNames(Map<String,String> names)
```
    Sets a list of singular names (language - value pairs)
  - getSingularNames
```
public Map<String,String> getSingularNames()
```
    Gets a list of singular names (language - value pairs)
  - setPluralNames
```
public void setPluralNames(Map<String,String> names)
```
    Sets a list of plural names (language - value pairs)
  - getPluralNames
```
public Map<String,String> getPluralNames()
```
    Gets a list of plural names (language - value pairs)
  - getShortedText
```
protected String getShortedText(String fieldName,
                                MMObjectNode node)
```
    Get text from a blob field. This function is called to 'load' a field into the node, because it was not loaded together with the node, because it is supposed to be too big.
    
    Parameters:
    
    fieldName - name of the field
    
    node -
    
    Returns:
    
    a String containing the complate contents of a field as text.
    
    Since:
    
    MMBase-1.8
  - getShortedByte
```
protected byte[] getShortedByte(String fieldName,
                                MMObjectNode node)
```
    Deprecated. Use getShortedInputStream(java.lang.String, org.mmbase.module.core.MMObjectNode)
    
    Get binary data of a blob field. This function is called to 'load' a field into the node, because it was not loaded together with the node, because it is supposed to be too big.
    
    Parameters:
    
    fieldName - name of the field
    
    node -
    
    Returns:
    
    an array of byte containing the complete contents of the field.
    
    Since:
    
    MMBase-1.8
  - getShortedInputStream
```
protected InputStream getShortedInputStream(String fieldName,
                                            MMObjectNode node)
```
    Get binary data of a blob field. This function is called to 'load' a field into the node, because it was not loaded together with the node, because it is supposed to be too big.
    
    Parameters:
    
    fieldName - name of the field
    
    node -
    
    Since:
    
    MMBase-1.9.1
  - setValue
```
public boolean setValue(MMObjectNode node,
                        String fieldName,
                        Object originalValue)
```
    Sets a key/value pair in the main values of this node. Note that if this node is a node in cache, the changes are immediately visible to everyone, even if the changes are not committed. The fieldname is added to the (public) 'changed' vector to track changes.
    
    Parameters:
    
    fieldName - the name of the field to change
    
    node - The node on which to change the field (the new value is in this node)
    
    originalValue - the value which was original in the field
    
    Returns:
    
    true When an update is required(when changed), false if original value was set back into the field.
  - setValue
```
public boolean setValue(MMObjectNode node,
                        String fieldName)
```
    Provides additional functionality when setting field values. This method is called whenever a Node of the builder's type tries to change a value. It allows the system to add functionality such as checking valid data. Derived builders should override this method if they want to add functionality.
    
    Parameters:
    
    node - the node whose fields are changed
    
    fieldName - the fieldname that is changed
    
    Returns:
    
    true if the call was handled.
  - getHTML
```
protected String getHTML(String body)
```
    Deprecated.
    
    Returns a HTML-version of a string. This replaces a number of tokens with HTML sequences. The default output does not match well with the new xhtml standards (ugly html), nor does it replace all tokens. Default replacements can be overridden by setting the builder properties in your .xml: html.alinea html.endofline Example: <br /> <br /> <br />
    
    Parameters:
    
    body - text to convert
    
    Returns:
    
    the convert text
  - getWAP
```
protected static String getWAP(String body)
```
    Returns a WAP-version of a string. This replaces a number of tokens with WAP sequences.
    
    Parameters:
    
    body - text to convert
    
    Returns:
    
    the convert text
  - getURLEncode
```
protected static String getURLEncode(String body)
```
    Returns a URLEncoded-version (MIME x-www-form-urlencoded) of a string. This version uses the java.net.URLEncoder class to encode it.
    
    Parameters:
    
    body - text to convert
    
    Returns:
    
    the URLEncoded text
  - getShort
```
public String getShort(String str,
                       int len)
```
    Support routine to return shorter strings. Cuts a string to a amximum length if it exceeds the length specified.
    
    Parameters:
    
    str - the string to shorten
    
    len - the maximum length
    
    Returns:
    
    the (possibly shortened) string
  - setFields
```
public void setFields(List<CoreField> f)
```
    Stores fields information of this table. Asside from the fields supplied by the caller, a field 'otype' is added (if missing).
    
    Parameters:
    
    f - A List with fields (as CoreField objects) as defined by MMBase. This may not be in sync with the actual database table, about which Storage will report then.
  - setXMLPath
```
public void setXMLPath(String m)
```
    Sets the subpath of the builder's xml configuration file.
  - getXMLPath
```
public String getXMLPath()
```
    Retrieves the subpath of the builder's xml configuration file. Needed for builders that reside in subdirectories in the builder configuration file directory.
  - getConfigResource
```
public String getConfigResource()
```
    Since:
    
    MMBase-1.8
  - getConfigFile
```
public File getConfigFile()
```
    Deprecated. Need something as getConfigResource in stead.
    
    Gets the file that contains the configuration of this builder
    
    Returns:
    
    the builders configuration File object
  - setInitParameters
```
void setInitParameters(Map<String,String> properties)
```
    Set all builder properties Changed properties will not be saved.
    
    Parameters:
    
    properties - the properties to set
  - getInitParameters
```
public Map<String,String> getInitParameters()
```
    Get all builder properties
    
    Returns:
    
    a Map containing the current properties
  - loadInitParameters
```
public void loadInitParameters()
```
    Override properties through application context
    
    Since:
    
    MMBase 1.8.5
  - getInitParameters
```
public Map<String,String> getInitParameters(String contextPath)
```
    Get all builder properties and override properties through application context
    
    Parameters:
    
    contextPath - path in application context where properties are located
    
    Returns:
    
    a Map containing the current properties
    
    Since:
    
    MMBase 1.8.2
  - setInitParameter
```
public void setInitParameter(String name,
                             String value)
```
    Set a single builder property The propertie will not be saved.
    
    Parameters:
    
    name - name of the property
    
    value - value of the property
  - getInitParameter
```
public String getInitParameter(String name)
```
    Retrieve a specific property.
    
    Parameters:
    
    name - the name of the property to get
    
    Returns:
    
    the value of the property as a String
  - setVersion
```
public void setVersion(int i)
```
    Sets the version of this builder
    
    Parameters:
    
    i - the version number
  - getVersion
```
public int getVersion()
```
    Retrieves the version of this builder
    
    Returns:
    
    the version number
  - getMaintainer
```
public String getMaintainer()
```
    Retrieves the maintainer of this builder
    
    Returns:
    
    the name of the maintainer
  - setMaintainer
```
public void setMaintainer(String m)
```
    Sets the maintainer of this builder
    
    Parameters:
    
    m - the name of the maintainer
  - hostname_function
```
public static String hostname_function(String url)
```
    Deprecated. Has nothing to do with mmbase nodes. Should be in org.mmbase.util
    
    hostname, parses the hostname from a url, so http://www.mmbase.org/bug becomed www.mmbase.org
  - wrap
```
public static String wrap(String text,
                          int width)
```
    Wraps a string. Inserts newlines (\n) into a string at periodic intervals, to simulate wrapping. This also removes whitespace to the start of a line.
    
    Parameters:
    
    text - the text to wrap
    
    width - the maximum width to wrap at
    
    Returns:
    
    the wrapped tekst
  - toString
```
public String toString()
```
    Implmenting a sensible toString is usefull for debugging.
    
    Overrides:
    
    toString in class Object
    
    Since:
    
    MMBase-1.6.2
  - equals
```
public final boolean equals(Object o)
```
    Equals must be implemented because of the list of MMObjectBuilder which is used for ancestors Declared the method final, because the instanceof operator is used. This is the only MMObjectBuilder is frequently extended and subclasses will always break the equals contract. When subclasses require to implement the equals method then we should use getClass() == o.getClass(), but this has its own issues. For more info, search for equality in Java
    
    Overrides:
    
    equals in class Object
    
    Since:
    
    MMBase-1.6.2
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - toString
```
public String toString(MMObjectNode n)
```
    Implements for MMObjectNode
    
    Since:
    
    MMBase-1.6.2
  - equals
```
public boolean equals(MMObjectNode o1,
                      MMObjectNode o2)
```
    Implements equals for nodes (this is in MMObjectBuilder because you cannot override MMObjectNode)
    
    Since:
    
    MMBase-1.6.2
  - hashCode
```
public int hashCode(MMObjectNode o)
```
    Implements for MMObjectNode
    
    Since:
    
    MMBase-1.6.2
  - addEventListener
```
public void addEventListener(EventListener listener)
```
    simple way to register a NodeEvent listener and a RelationEventListener at the same time.
    
    Parameters:
    
    listener -
    
    Since:
    
    MMBase-1.8
    
    See Also:
    
    MMBase.addNodeRelatedEventsListener(java.lang.String, org.mmbase.core.event.EventListener)
  - removeEventListener
```
public void removeEventListener(EventListener listener)
```
    Parameters:
    
    listener -
    
    Since:
    
    MMBase-1.8
  - notify
```
public void notify(NodeEvent event)
```
    Specified by:
    
    notify in interface NodeEventListener
    
    Since:
    
    MMBase-1.8
    
    See Also:
    
    here we handle all the backward compatibility stuff. this method covers for both node and relation events.
  - notify
```
public void notify(RelationEvent event)
```
    Specified by:
    
    notify in interface RelationEventListener
    
    Since:
    
    MMBase-1.8
  - isNull
```
protected boolean isNull(String fieldName,
                         MMObjectNode node)
```

Class MMObjectBuilder

Field Summary

Fields inherited from class org.mmbase.module.core.MMTable

Fields inherited from class org.mmbase.util.functions.FunctionProvider

Constructor Summary

Method Summary

Methods inherited from class org.mmbase.module.core.MMTable

Methods inherited from class org.mmbase.util.functions.FunctionProvider

Methods inherited from class java.lang.Object

Field Detail

FIELD_NUMBER

FIELD_OWNER

FIELD_OBJECT_TYPE

TMP_FIELD_NUMBER

TMP_FIELD_EXISTS

TMP_FIELD_RESOLVED

SYSTEM_OWNER

TEMPNODE_DEFAULT_SIZE

DEFAULT_ALINEA

DEFAULT_EOL

EVENT_TYPE_LOCAL

EVENT_TYPE_REMOTE

AGE_PARAMETERS

temporaryNodes

GUI_INDICATOR

genericBlobCache

nodeCache

description

descriptions

searchAge

broadCastChanges

internalVersion

oType

maintainer

singularNames

pluralNames

xmlPath

GUI_PARAMETERS

guiFunction

WRAP_PARAMETERS

wrapFunction

getFunctions

infoFunction

fields

virtual

Constructor Detail

MMObjectBuilder

Method Detail

init

createIfNotExists

shutdown

getNumber

getObjectType

update

getInternalVersion

create

delete

testValidData

insert

insert

preCommit

commit

broadcastChanges

createAlias

createAlias

getParentBuilder

getAncestors

getDescendants

setParentBuilder

getDataTypeCollector

isExtensionOf

getNewNode

getEmptyNode

setDefaults

setUniqueValue

setUniqueValue

removeNode

removeSyncNodes

removeRelations

isNodeCached