com.jalios.jcms

Class LinkIndexManager

java.lang.Object

com.jalios.jcms.LinkIndexManager

public class LinkIndexManager
extends java.lang.Object

This class manages the Custom Type link index. It is intended to return a Set of Data targeted by a given Data that has a pointer on each of these Data. Since JCMS-3.1, these reverse links are managed at 'field-level'. That is, referencing data can be request for a given field (e.g. get all the data referrencing the given data with field 'myLink').

 TreeMap
   Key: The data which is referenced by 
   Value:
     HashMap: (classMap)
       Key: Class (the class referencing the data) 
       Value: (fieldMap)
         HashMap:
           Key: String (the name of the field referencing the data)
           Value: TreeSet containing all the referencing data
 

Version:

$Revision: 83828 $

Author:

Olivier Dedieu

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_FIELD_KEY
static java.lang.String	REVISION

Constructor Summary

Constructors

Constructor and Description
LinkIndexManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkLinkIndex() Check that "all" field entries are consistent with the other fields.
java.util.TreeMap<Data,java.util.Map<java.lang.Class<?>,java.util.Map<java.lang.String,java.util.TreeSet<Data>>>>	getIndex()
<T> java.util.TreeSet<T>	getIndexedDataSet(Data data, java.lang.Class<T> clazz) Returns the Set of clazz instances referring this data (whatever the field they used for this reference)
<T> java.util.TreeSet<T>	getIndexedDataSet(Data data, java.lang.Class<T> clazz, java.lang.String field) Returns the Set of clazz instances referring this data with the given field.
int	getLinkCount(Data data)
java.util.Map<java.lang.Class<? extends Publication>,java.util.Set<TypeFieldEntry>>	getTypeLinkMap(java.lang.Class<? extends Publication> clazz) Returns the type link map for the given class.
java.util.Set<TypeFieldEntry>	getTypeLinkSet(java.lang.Class<? extends Publication> attachedClass, java.lang.Class<? extends Publication> assignedClass) Returns the set of TypeFieldEntry of assignedClass that can be assigned with attachedClass.
void	printLinkIndex(java.io.PrintWriter pw) Print an XML view of the index.

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

ALL_FIELD_KEY

public static final java.lang.String ALL_FIELD_KEY

See Also:

Constant Field Values

Constructor Detail

LinkIndexManager

public LinkIndexManager()

Method Detail

getTypeLinkMap

public java.util.Map<java.lang.Class<? extends Publication>,java.util.Set<TypeFieldEntry>> getTypeLinkMap(java.lang.Class<? extends Publication> clazz)

Returns the type link map for the given class. The type link map contains the class .

Parameters:

clazz - the class.

Returns:

the link link map for the given class.

Since:

jcms-9.0.0

getTypeLinkSet

public java.util.Set<TypeFieldEntry> getTypeLinkSet(java.lang.Class<? extends Publication> attachedClass,
                                           java.lang.Class<? extends Publication> assignedClass)

Returns the set of TypeFieldEntry of assignedClass that can be assigned with attachedClass.

Parameters:

attachedClass - the class to be attached.

assignedClass - the class to be assigned.

Returns:

the set of TypeFieldEntry of assignedClass that can be assigned with attachedClass.

Since:

jcms-9.0.0

getIndex

public java.util.TreeMap<Data,java.util.Map<java.lang.Class<?>,java.util.Map<java.lang.String,java.util.TreeSet<Data>>>> getIndex()

getIndexedDataSet

public <T> java.util.TreeSet<T> getIndexedDataSet(Data data,
                                         java.lang.Class<T> clazz)

Returns the Set of clazz instances referring this data (whatever the field they used for this reference)

Type Parameters:

T - any object type (usually something extending Data)

Parameters:

data - the data

clazz - the class to search the referring instances

Returns:

a TreeSet of Data

Since:

jcms-3.0

getIndexedDataSet

public <T> java.util.TreeSet<T> getIndexedDataSet(Data data,
                                         java.lang.Class<T> clazz,
                                         java.lang.String field)

Returns the Set of clazz instances referring this data with the given field.

Type Parameters:

T - any object type (usually something extending Data)

Parameters:

data - the data

clazz - the class to search the referring instances

field - the name of the field which contains the reference

Returns:

a TreeSet of Data

Since:

jcms-4.0

getLinkCount

public int getLinkCount(Data data)

Parameters:

data - the data

Returns:

the number of instances referring this data

Since:

jcms-3.0

checkLinkIndex

public void checkLinkIndex()

Check that "all" field entries are consistent with the other fields.

Since:

jcms-5.0.5

printLinkIndex

public void printLinkIndex(java.io.PrintWriter pw)

Print an XML view of the index.

Parameters:

pw - the printWriter where the XML view must be printed.

Since:

jcms-5.0.5