org.mmbase.module.builders
Class Teasers

java.lang.Object
  |
  +--org.mmbase.module.core.MMTable
        |
        +--org.mmbase.module.core.MMObjectBuilder
              |
              +--org.mmbase.module.builders.Teasers

public class Teasers

extends MMObjectBuilder

Version:

$Id: Teasers.java,v 1.20 2002/01/29 10:57:15 pierre Exp $

Author:

Daniel Ockeloen, Rico Jansen

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

broadcastChanges, className, database, debug, description, descriptions, fields, NODE_MAX_SIZE, nodeCache, obj2type, OBJ2TYPE_MAX_SIZE, oType, replaceCache, searchAge, sortedDBLayout, TEMPNODE_DEFAULT_SIZE, TemporaryNodes, virtual

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

mmb, tableName

Constructor Summary

Teasers()

Method Summary

java.lang.String	getDefaultUrl(int src) Return the default url of this object.
java.lang.String	getGUIIndicator(java.lang.String field, MMObjectNode node) What should a GUI display for this node/field combo.
java.util.Vector	getList(scanpage sp, StringTagger tagger, java.util.StringTokenizer tok) Generate a list of values from a command to the processor
java.lang.Object	getValue(MMObjectNode node, java.lang.String field) Provides additional functionality when obtaining field values.
java.util.Vector	insertRelations(java.util.Vector nodes) Return a vector of teasers with the realtions flattened into the result Called by Pool builder
boolean	nodeLocalChanged(java.lang.String machine, java.lang.String number, java.lang.String builder, java.lang.String ctype) Called when a local node is changed.

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

addField, addLocalObserver, addRemoteObserver, buildSet, checkAddTmpField, commit, convertMMNode2SQL, count, create, createAlias, created, debug, deleteNodeCache, executeFunction, fieldLocalChanged, getAge, getAliasedNode, getCacheNumbers, getCacheSize, getCacheSize, getClassName, getDBByte, getDBKey, getDBState, getDBText, getDBType, getDefaultTeaser, getDescription, getDescriptions, getDutchSName, getEditFields, getField, getFieldNames, getFields, getFullTableName, getFunctionParameters, getGUIIndicator, getHardNode, getHardNode, getHTML, getInitParameter, getInitParameters, getMachineName, getMaintainer, getNewNode, getNewTmpNode, getNextField, getNode, getNode, getNode, getNode, getNodeType, getNumberFromName, getPluralName, getPluralName, getPluralNames, getRelations_main, getSearchAge, getShort, getShortedByte, getShortedText, getSingularName, getSingularName, getSingularNames, getSmartPath, getSortedFields, getSortedListFields, getTableName, getTmpNode, getURLEncode, getVersion, getWAP, getXMLPath, getXMLSetup, hostname_function, init_obj2type, init, insert, insert, insertDone, isNodeCached, isVirtual, isXMLConfig, nodeRemoteChanged, preCommit, preEdit, process, putTmpNode, readSearchResults, removeField, removeNode, removeRelations, removeTmpNode, replace, safeCache, safeCommit, safeInsert, search, search, search, searchIn, searchIn, searchIn, searchNumbers, searchVector, searchVector, searchVector, searchVector, searchVectorIn, searchVectorIn, searchVectorIn, searchVectorIn, searchWithWhere, sendFieldChangeSignal, setClassName, setDBLayout_xml, setDBLayout, setDebug, setDefaults, setDescription, setDescriptions, setDutchSName, setInitParameter, setMaintainer, setMMBase, setPluralNames, setSearchAge, setSingularNames, setTableName, setValue, setValue, setVersion, setXmlConfig, setXMLPath, setXMLValues, signalNewObject, testValidData, toXML, waitUntilNodeChanged, wrap

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

size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Teasers

public Teasers()

Method Detail

getGUIIndicator

public java.lang.String getGUIIndicator(java.lang.String field,
                                        MMObjectNode node)

Description copied from class: MMObjectBuilder

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.

Overrides:

getGUIIndicator in class MMObjectBuilder

Following copied from class: org.mmbase.module.core.MMObjectBuilder

Parameters:

node - The node to display

field - the name field of the field to display

Returns:

the display of the node's field as a String, null if not specified

getList

public java.util.Vector getList(scanpage sp,
                                StringTagger tagger,
                                java.util.StringTokenizer tok)
                         throws ParseException

Generate a list of values from a command to the processor

Overrides:

getList in class MMObjectBuilder

Following copied from class: org.mmbase.module.core.MMObjectBuilder

Parameters:

sp - The scanpage (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

getValue

public java.lang.Object getValue(MMObjectNode node,
                                 java.lang.String field)

Description copied from class: MMObjectBuilder

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 MMObjectBuilder.executeFunction(org.mmbase.module.core.MMObjectNode, java.lang.String, java.lang.String) 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 addiitonal functions, override MMObjectBuilder.executeFunction(org.mmbase.module.core.MMObjectNode, java.lang.String, java.lang.String) instead.

Overrides:

getValue in class MMObjectBuilder

Following copied from class: org.mmbase.module.core.MMObjectBuilder

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.

getDefaultUrl

public java.lang.String getDefaultUrl(int src)

Description copied from class: MMObjectBuilder

Return the default url of this object. The basic value returned is null.

Overrides:

getDefaultUrl in class MMObjectBuilder

Following copied from class: org.mmbase.module.core.MMObjectBuilder

Parameters:

src - the number of the node to obtain the url from

Returns:

the basic url as a String, or null if unknown.

nodeLocalChanged

public boolean nodeLocalChanged(java.lang.String machine,
                                java.lang.String number,
                                java.lang.String builder,
                                java.lang.String ctype)

Description copied from class: MMObjectBuilder

Called when a local node is changed. Should be called by subclasses if they override it.

Overrides:

nodeLocalChanged in class MMObjectBuilder

Following copied from class: org.mmbase.module.core.MMObjectBuilder

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

insertRelations

public java.util.Vector insertRelations(java.util.Vector nodes)

Return a vector of teasers with the realtions flattened into the result Called by Pool builder