Package com.jalios.jcms

Class DataIndexManager

java.lang.Object

com.jalios.jcms.AbstractIndexManager

com.jalios.jcms.DataIndexManager

public class DataIndexManager
extends AbstractIndexManager

Nested Class Summary

Nested classes/interfaces inherited from class com.jalios.jcms.AbstractIndexManager

AbstractIndexManager.DataIndex<D extends Data,C>, AbstractIndexManager.DataIndexMap<D extends Data,K,V>, AbstractIndexManager.DataIndexSet<D extends Data,E>

Field Summary

Fields inherited from class com.jalios.jcms.AbstractIndexManager

channel

Method Summary

Modifier and Type	Method	Description
java.lang.Object	getExtraInfo(Data data, java.lang.String key)	Returns the ExtraInfo which is associated to the given key for the given data.
java.util.Map<java.lang.String,java.lang.Object>	getExtraInfoMap(Data data)	Returns the ExtraInfo Map which is associated to the given data.
static DataIndexManager	getInstance()
java.lang.Object	putExtraInfo(Data data, java.lang.String key, java.lang.Object value)	Associates the given ExtraInfo for the given data.
java.lang.Object	removeExtraInfo(Data data, java.lang.String key)	Removes the mapping for this key from this map if it is present.
java.util.Map<java.lang.String,java.lang.Object>	removeExtraInfoMap(Data data)	Removes and returns the ExtraInfo Map which is associated to the given data.
java.util.Map<java.lang.String,java.lang.Object>	setExtraInfoMap(Data data, java.util.Map<java.lang.String,java.lang.Object> extraInfoMap)	Set the ExtraInfo Map associated to the given data.

Methods inherited from class com.jalios.jcms.AbstractIndexManager

addIndexWithSet, addIndexWithSet, clearIndex, getIndexWithMap, getIndexWithMap, getIndexWithSet, getOriginalData, isUndefinedIndexWithSet, putIndexWithMap, removeIndexWithMap, removeIndexWithSet, removeIndexWithSet, setIndexWithSet

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DataIndexManager getInstance()

getExtraInfoMap

public java.util.Map<java.lang.String,java.lang.Object> getExtraInfoMap(Data data)

Returns the ExtraInfo Map which is associated to the given data.

Parameters:

data - the data to get the ExtraInfo Map

Returns:

the ExtraInfo Map which is associated to the given data.

Since:

jcms-6.0.0

getExtraInfo

public java.lang.Object getExtraInfo(Data data,
                                     java.lang.String key)

Returns the ExtraInfo which is associated to the given key for the given data.

Parameters:

data - the data to get the ExtraInfo

key - whose associated value is to be returned.

Returns:

the ExtraInfo which is associated to the given key for the given data.

Since:

jcms-6.0.0

putExtraInfo

public java.lang.Object putExtraInfo(Data data,
                                     java.lang.String key,
                                     java.lang.Object value)

Associates the given ExtraInfo for the given data.

Parameters:

data - data with which this ExtraInfo is to be associated.

key - key with which the specified value is to be associated.

value - valuee to be associated with the specified key.

Returns:

previous value associated with specified key, or null if there was no mapping for key. A null return can also indicate that the map previously associated null with the specified key, if the implementation supports null values.

Since:

jcms-6.0.0

removeExtraInfo

public java.lang.Object removeExtraInfo(Data data,
                                        java.lang.String key)

Removes the mapping for this key from this map if it is present.

Parameters:

data - data with which this ExtraInfo is to be associated.

key - key whose mapping is to be removed from the map.

Returns:

previous value associated with specified key, or null if there was no mapping for key.

Since:

jcms-6.0.0

removeExtraInfoMap

public java.util.Map<java.lang.String,java.lang.Object> removeExtraInfoMap(Data data)

Removes and returns the ExtraInfo Map which is associated to the given data.

Parameters:

data - the data from which to get and remove the ExtraInfo Map

Returns:

the ExtraInfo Map which is associated to the given data.

Since:

JCMS-3804

setExtraInfoMap

public java.util.Map<java.lang.String,java.lang.Object> setExtraInfoMap(Data data,
                                                                              java.util.Map<java.lang.String,java.lang.Object> extraInfoMap)

Set the ExtraInfo Map associated to the given data.

Replace any exiting map already associated to the data.

Parameters:

data - the data for which to set the ExtraInfo Map

extraInfoMap - the map to associate to the specified data

Returns:

the previous ExtraInfo Map associated to the given data.

Since:

JCMS-3804