org.mmbase.module.builders
Class DayMarkers

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

All Implemented Interfaces:

EventListener, NodeEventListener, RelationEventListener

public class DayMarkers

extends MMObjectBuilder

Daymarkers are used to calculate the age of MMBase objects. Every day a daymarker is added to the daymarks table. Such an entry consists of a daycount (number of days from 1970), and a count (current object number of that day).

Version:

$Id: DayMarkers.java,v 1.42 2005/10/04 22:52:58 michiel Exp $

Author:

Daniel Ockeloen,Rico Jansen, Michiel Meeuwissen

Field Summary

static String	FIELD_DAYCOUNT
static String	FIELD_MARK
static long	MILLISECONDS_IN_A_DAY
static long	SECONDS_IN_A_DAY

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, getFunctions, GUI_PARAMETERS, guiFunction, infoFunction, internalVersion, nodeCache, oType, searchAge, SYSTEM_OWNER, TEMPNODE_DEFAULT_SIZE, temporaryNodes, 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

Constructor Summary

DayMarkers()
set the current day.

Method Summary

int	getAge(int nodeNumber) Returns the age, in days, of a node.
Date	getDate(MMObjectNode node) Returns the date of a daymarker
int	getDayCount() The current day count.
int	getDayCountAge(int daysold) Given an age, this function returns a mark, _not a day count_, and also _not an age_!
int	getDayCountByObject(int number)
String	getLocaleGUIIndicator(Locale locale, MMObjectNode node) Returns gui information for a specific node.
int	getMonthsByDayCount(int daycount)
boolean	init() Calculate smallestMark, and smallestDay.
void	probe() This gets called every hour to see if the day has past.
String	replace(PageInfo sp, StringTokenizer command) Scan.

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

addEventListener, addField, addLocalObserver, addRemoteObserver, broadcastChanges, checkAddTmpField, clearBlobCache, commit, create, createAlias, createAlias, delete, equals, equals, executeFunction, executeFunction, fieldLocalChanged, getAncestors, getBlobCache, getClassName, getConfigFile, getConfigResource, getDataTypeCollector, getDBKey, getDBState, getDBType, getDefaultTeaser, getDefaultUrl, getDescendants, getDescription, getDescription, getDescriptions, getEditFields, getEmptyNode, getField, getFieldNames, getFields, getFields, getFunction, getFunctionParameters, getFunctions, getGUIIndicator, getGUIIndicator, getGUIIndicator, getHardNode, getHardNode, getHTML, getInitParameter, getInitParameters, getInternalVersion, getList, getLocaleGUIIndicator, getMachineName, getMaintainer, getNewNode, getNewTmpNode, getNextField, getNextField, getNode, getNode, getNode, getNodeFromCache, getNodeGUIIndicator, getNumber, getObjectType, getObjectValue, getParentBuilder, getPluralName, getPluralName, getPluralNames, getRelations_main, getSearchAge, getShort, getShortedByte, getShortedText, getSingularName, getSingularName, getSingularNames, getSmartPath, getSortedFields, getSortedListFields, getTmpNode, getURLEncode, getValue, getVersion, getWAP, getXMLPath, hasField, hashCode, hashCode, hostname_function, insert, insert, isExtensionOf, isNodeCached, isVirtual, newFunctionInstance, nodeLocalChanged, nodeRemoteChanged, notify, notify, preCommit, process, putTmpNode, removeEventListener, removeField, removeLocalObserver, removeNode, removeRelations, removeRemoteObserver, removeSyncNodes, removeTmpNode, safeCache, sendFieldChangeSignal, setDefaults, setDescription, setDescriptions, setFields, setInitParameter, setMaintainer, setParentBuilder, setPluralNames, setSearchAge, setSingularNames, setUniqueValue, setUniqueValue, setValue, setValue, setVersion, setXMLPath, 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

FIELD_DAYCOUNT

public static final String FIELD_DAYCOUNT

See Also:

Constant Field Values

FIELD_MARK

public static final String FIELD_MARK

See Also:

Constant Field Values

SECONDS_IN_A_DAY

public static final long SECONDS_IN_A_DAY

See Also:

Constant Field Values

MILLISECONDS_IN_A_DAY

public static final long MILLISECONDS_IN_A_DAY

See Also:

Constant Field Values

Constructor Detail

DayMarkers

public DayMarkers()

set the current day. This is the number of days from 1970.

Method Detail

init

public boolean init()

Calculate smallestMark, and smallestDay. smallestMark is the smallest object number for which a daymark exists. smallestDay is the first daymarker that was set.

Overrides:

init in class MMObjectBuilder

Returns:

true if init was completed, false if uncompleted.

See Also:

MMObjectBuilder.create()

probe

public void probe()

This gets called every hour to see if the day has past.

getAge

public int getAge(int nodeNumber)

Returns the age, in days, of a node. So, this does the inverse of most methods in this class. It converts a node number (which is like a mark) to a day.

getDayCount

public int getDayCount()

The current day count.

Returns:

the number of days from 1970 of today.

getDayCountAge

public int getDayCountAge(int daysold)

Given an age, this function returns a mark, _not a day count_, and also _not an age_!

Parameters:

daysold - a time in days ago.

Returns:

the smallest object number of all objects that are younger than given parameter daysold.

replace

public String replace(PageInfo sp,
                      StringTokenizer command)

Scan. Known tokens are: COUNT-X gets an object number of X days after 1970 COUNTAGE-X gets an object number of X days old COUNTMONTH-X gets an object number of X months after 1970 COUNTNEXTMONTH-X gets an object number of X+1 months after 1970 COUNTPREVMONTH-X gets an object number of X-1 months after 1970 COUNTPREVDELTAMONTH-X-Y gets an object number of X-Y months after 1970 COUNTNEXTDELTAMONTH-X-Y gets an object number of X+Y months after 1970 TIMETOOBJECTNUMBER gets an object number of X seconds after 1970

Overrides:

replace in class MMObjectBuilder

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

Returns:

the result value as a String

getDayCountByObject

public int getDayCountByObject(int number)

Warning: No Java Documentation Available.

getMonthsByDayCount

public int getMonthsByDayCount(int daycount)

Warning: No Java Documentation Available.

getDate

public Date getDate(MMObjectNode node)

Returns the date of a daymarker

Parameters:

node - The node of which the date is wanted

Returns:

a Date which is the date

getLocaleGUIIndicator

public String getLocaleGUIIndicator(Locale locale,
                                    MMObjectNode node)

Returns gui information for a specific node. This value is retrieved by retrieving the field 'gui()' of the node (node.getStringValue("gui()") )

Overrides:

getLocaleGUIIndicator in class MMObjectBuilder

Parameters:

node - The node of which the gui information is wanted

Returns:

a String in which the current date is shown