org.mmbase.storage.search
Class ResultBuilder

Package class diagram package ResultBuilder
java.lang.Object
  extended by org.mmbase.util.functions.FunctionProvider
      extended by org.mmbase.module.core.MMTable
          extended by org.mmbase.module.core.MMObjectBuilder
              extended by org.mmbase.module.core.VirtualBuilder
                  extended by org.mmbase.storage.search.ResultBuilder
All Implemented Interfaces:
EventListener, NodeEventListener, RelationEventListener

public class ResultBuilder
extends VirtualBuilder

A ResultBuilder is a builder for ResultNodes, that represent the results of executing an arbitrary search query.

This builder contains info on the fields of the resultnodes.

Since:
MMBase-1.7
Version:
$Id: ResultBuilder.java 45150 2011-02-10 09:18:12Z michiel $
Author:
Rob van Maris

Field Summary
protected static Cache<String,CoreField> fieldCache
           
 
Fields inherited from class org.mmbase.module.core.MMObjectBuilder
AGE_PARAMETERS, broadCastChanges, DEFAULT_ALINEA, DEFAULT_EOL, description, descriptions, EVENT_TYPE_LOCAL, EVENT_TYPE_REMOTE, FIELD_NUMBER, FIELD_OBJECT_TYPE, FIELD_OWNER, fields, genericBlobCache, getFunctionsFunction, GUI_INDICATOR, GUI_PARAMETERS, guiFunction, infoFunction, internalVersion, nodeCache, oType, pluralNames, searchAge, singularNames, SYSTEM_OWNER, TEMPNODE_DEFAULT_SIZE, TMP_FIELD_EXISTS, TMP_FIELD_NUMBER, virtual, WRAP_PARAMETERS, wrapFunction
 
Fields inherited from class org.mmbase.module.core.MMTable
maxNodesFromQuery, mmb, storageConnector, tableName
 
Fields inherited from class org.mmbase.util.functions.FunctionProvider
functions, getFunctions
 
Constructor Summary
ResultBuilder(MMBase mmbase, SearchQuery q)
          Creator.
 
Method Summary
 MMObjectNode getNewNode(String owner)
          Get a new node, using this builder as its parent.
 List<MMObjectNode> getResult()
           
 
Methods inherited from class org.mmbase.module.core.VirtualBuilder
create, getDBState, getFields, getGUIIndicator, getShortedByte, getShortedText, init, insert
 
Methods inherited from class org.mmbase.module.core.MMObjectBuilder
addEventListener, addField, addLocalObserver, addRemoteObserver, broadcastChanges, checkAddTmpField, clearBlobCache, commit, createAlias, createAlias, createIfNotExists, delete, equals, equals, executeFunction, executeFunction, fieldLocalChanged, getAncestors, getBlobCache, getClassName, getConfigFile, getConfigResource, getDataTypeCollector, getDBType, getDefaultTeaser, getDefaultUrl, getDescendants, getDescription, getDescription, getDescriptions, getEmptyNode, getField, getFieldNames, getFields, getFields, getFunction, getFunctionParameters, getFunctions, getGUIIndicator, getGUIIndicator, getHTML, getInitParameter, getInitParameters, getInitParameters, getInternalVersion, getList, getLocaleGUIIndicator, getLocaleGUIIndicator, getMachineName, getMaintainer, getNewTmpNode, getNextField, getNextField, getNode, getNode, getNode, getNodeFromCache, getNodeGUIIndicator, getNumber, getObjectType, getObjectValue, getParentBuilder, getPluralName, getPluralName, getPluralNames, getRelations_main, getSearchAge, getShort, getShortedInputStream, getSingularName, getSingularName, getSingularNames, getSmartPath, getTmpNode, getURLEncode, getValue, getVersion, getWAP, getXMLPath, hasField, hashCode, hashCode, hostname_function, insert, isExtensionOf, isNodeCached, isNull, isVirtual, loadInitParameters, newFunctionInstance, nodeLocalChanged, nodeRemoteChanged, notify, notify, preCommit, process, removeEventListener, removeField, removeLocalObserver, removeNode, removeRelations, removeRemoteObserver, removeSyncNodes, replace, safeCache, sendFieldChangeSignal, setDefaults, setDescription, setDescriptions, setFields, setInitParameter, setMaintainer, setPluralNames, setSearchAge, setSingularNames, setUniqueValue, setUniqueValue, setValue, setValue, setVersion, setXMLPath, shutdown, testValidData, toString, toString, update, updateFields, wrap
 
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

fieldCache

protected static final Cache<String,CoreField> fieldCache
Constructor Detail

ResultBuilder

public ResultBuilder(MMBase mmbase,
                     SearchQuery q)
Creator. Creates new ResultBuilder instance, used to represent the results of executing a search query.

Parameters:
mmbase - MMBase instance.
query - The search query that defines the search.
Method Detail

getNewNode

public MMObjectNode getNewNode(String owner)
Description copied from class: VirtualBuilder
Get a new node, using this builder as its parent. The new node is a virtual node.

Overrides:
getNewNode in class VirtualBuilder
Parameters:
owner - The administrator creating the new node.
Returns:
A newly initialized VirtualNode.
See Also:
VirtualBuilder.getNewNode(java.lang.String)

getResult

public List<MMObjectNode> getResult()
                             throws StorageException,
                                    SearchQueryException
Throws:
StorageException
SearchQueryException


MMBase2 Core 2.0-SNAPSHOT - 2013-11-29T11:08