de.hybris.platform.print.jalo.link

Class CrossreferenceManager

java.lang.Object

de.hybris.platform.print.jalo.link.CrossreferenceManager

public class CrossreferenceManager
extends Object

Manager class that helps creating, managing, processing and deleting crossreferences

Field Summary

Fields

Modifier and Type	Field and Description
static String	CROSSREFERENCE_LINK_PATTERN pattern for links

Constructor Summary

Constructors

Constructor and Description
CrossreferenceManager()

Method Summary

Modifier and Type	Method and Description
Crossreference	createCrossreference(String qualifier, Item source, Item target, String linkId) Creates a crossreference from the source Item to the target Item
Crossreference	createCrossreference(String qualifier, Item source, Item target, String attribute, Language language, String linkId) Creates a crossreference from the source Item to the target Item
Crossreference	getCrossreference(Item source, Item target) Returns the (first found) crossreference from the source Item to the target Item
Crossreference	getCrossreference(String qualifier, Item source, Item target, String attribute, Language language) Returns the (first found) crossreference from the source Item to the target Item
Crossreference	getCrossreferenceById(CatalogVersion catver, String linkId) Returns crossreference with the given catalogversion and id.
Collection<Crossreference>	getCrossreferences(Item source) Returns all crossreferences from the source Item to any target Item
Collection<Crossreference>	getCrossreferences(Item source, Language language) Returns all crossreferences from the source Item to any target Item
Collection<Crossreference>	getCrossreferences(Item source, String attribute) Returns all crossreferences from the source Item to any target Item
Collection<Crossreference>	getCrossreferences(Item source, String attribute, Language language) Returns all crossreferences from the source Item to any target Item
Collection<Crossreference>	getCrossreferences(String qualifier, Item source) Returns all crossreferences from the source Item to any target Item
Collection<Crossreference>	getCrossreferences(String qualifier, Item source, Item target, String attribute, Language language) Returns all crossreferences from the source Item to the target Item
Collection<Crossreference>	getCrossreferences(String qualifier, Item source, String attribute, Language language) Returns all crossreferences from the source Item to any target Item
Collection<Crossreference>	getCrossreferencesByTarget(Item target) Returns all crossreferences from any source Item to the specified target Item
Collection<Crossreference>	getCrossreferencesByTarget(String qualifier, Item target) Returns all crossreferences from any source Item to the specified target Item
Collection<Crossreference>	getCrossreferencesForRemoving(Item item) This method returns all Crossreferences where either the target of the Crossreference is the given item or the source of the Crossreference.
static CrossreferenceManager	getInstance()
void	setOrRemoveCrossreferences(SessionContext ctx, Item source, String attribute, Language language, String html) Checks the given html text for new or removed crossreferences and updates the Crossreference object accordingly.

Methods inherited from class java.lang.Object

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

Field Detail

CROSSREFERENCE_LINK_PATTERN

public static final String CROSSREFERENCE_LINK_PATTERN

pattern for links

See Also:

Constant Field Values

Constructor Detail

CrossreferenceManager

public CrossreferenceManager()

Method Detail

getInstance

public static CrossreferenceManager getInstance()

Returns:

A (singleton) Instance of this Class

createCrossreference

public Crossreference createCrossreference(String qualifier,
                                           Item source,
                                           Item target,
                                           String linkId)

Creates a crossreference from the source Item to the target Item

Parameters:

qualifier - A qualifier for this crossreference (might be null)

source - The source Item

target - The target Item

linkId - Unique ID of the reference item

Returns:

The created Crossreference

createCrossreference

public Crossreference createCrossreference(String qualifier,
                                           Item source,
                                           Item target,
                                           String attribute,
                                           Language language,
                                           String linkId)

Creates a crossreference from the source Item to the target Item

Parameters:

qualifier - A qualifier for this crossreference (might be null)

source - The source Item

target - The target Item

attribute - The (String)attribute's qualifier where the crossreference is contained in the source Item

language - The language for which the crossreference is contained in the source Item's attribute

linkId - Unique ID of the reference item

Returns:

The created Crossreference

getCrossreference

public Crossreference getCrossreference(Item source,
                                        Item target)
                                 throws JaloInvalidParameterException

Returns the (first found) crossreference from the source Item to the target Item

Parameters:

source - The source Item

target - The target Item

Returns:

The (first found) crossreference

Throws:

JaloInvalidParameterException - If parameters are not (correctly) specified

getCrossreference

public Crossreference getCrossreference(String qualifier,
                                        Item source,
                                        Item target,
                                        String attribute,
                                        Language language)
                                 throws JaloInvalidParameterException

Returns the (first found) crossreference from the source Item to the target Item

Parameters:

qualifier - The qualifier of the crossreference

source - The source Item

target - The target Item

attribute - The (String)attribute's qualifier where the crossreference is contained in the source Item

language - The language for which the crossreference is contained in the source Item's attribute

Returns:

The (first found) crossreference

Throws:

JaloInvalidParameterException - If parameters are not (correctly) specified

getCrossreferences

public Collection<Crossreference> getCrossreferences(Item source)

Returns all crossreferences from the source Item to any target Item

Parameters:

source - The source Item

Returns:

The crossreferences

Throws:

JaloInvalidParameterException - If parameters are not (correctly) specified

getCrossreferencesByTarget

public Collection<Crossreference> getCrossreferencesByTarget(Item target)

Returns all crossreferences from any source Item to the specified target Item

Parameters:

target - The target Item

Returns:

The crossreferences

Throws:

JaloInvalidParameterException - If parameters are not (correctly) specified

getCrossreferences

public Collection<Crossreference> getCrossreferences(String qualifier,
                                                     Item source)

Returns all crossreferences from the source Item to any target Item

Parameters:

qualifier - The qualifier of the crossreferences

source - The source Item

Returns:

The crossreferences

Throws:

JaloInvalidParameterException - If parameters are not (correctly) specified

getCrossreferencesByTarget

public Collection<Crossreference> getCrossreferencesByTarget(String qualifier,
                                                             Item target)

Returns all crossreferences from any source Item to the specified target Item

Parameters:

qualifier - The qualifier of the crossreferences

target - The target Item

Returns:

The crossreferences

Throws:

JaloInvalidParameterException - If parameters are not (correctly) specified

getCrossreferences

public Collection<Crossreference> getCrossreferences(Item source,
                                                     Language language)

Returns all crossreferences from the source Item to any target Item

Parameters:

source - The source Item

language - The language for which the crossreferences are contained in the source Item's attribute

Returns:

The crossreferences

Throws:

JaloInvalidParameterException - If parameters are not (correctly) specified

getCrossreferences

public Collection<Crossreference> getCrossreferences(Item source,
                                                     String attribute)

Returns all crossreferences from the source Item to any target Item

Parameters:

source - The source Item

attribute - The (String)attribute's qualifier where the crossreferences are contained in the source Item

Returns:

The crossreferences

Throws:

JaloInvalidParameterException - If parameters are not (correctly) specified

getCrossreferences

public Collection<Crossreference> getCrossreferences(Item source,
                                                     String attribute,
                                                     Language language)

Returns all crossreferences from the source Item to any target Item

Parameters:

source - The source Item

attribute - The (String)attribute's qualifier where the crossreferences are contained in the source Item

language - The language for which the crossreferences are contained in the source Item's attribute

Returns:

The crossreferences

Throws:

JaloInvalidParameterException - If parameters are not (correctly) specified

getCrossreferences

public Collection<Crossreference> getCrossreferences(String qualifier,
                                                     Item source,
                                                     String attribute,
                                                     Language language)

Returns all crossreferences from the source Item to any target Item

Parameters:

qualifier - The qualifier of the crossreferences

source - The source Item

attribute - The (String)attribute's qualifier where the crossreferences are contained in the source Item

language - The language for which the crossreferences are contained in the source Item's attribute

Returns:

The crossreferences

Throws:

JaloInvalidParameterException - If parameters are not (correctly) specified

getCrossreferences

public Collection<Crossreference> getCrossreferences(String qualifier,
                                                     Item source,
                                                     Item target,
                                                     String attribute,
                                                     Language language)
                                              throws JaloInvalidParameterException

Returns all crossreferences from the source Item to the target Item

Parameters:

qualifier - The qualifier of the crossreferences

source - The source Item

target - The target Item

attribute - The (String)attribute's qualifier where the crossreferences are contained in the source Item

language - The language for which the crossreferences are contained in the source Item's attribute

Returns:

The crossreferences

Throws:

JaloInvalidParameterException - If parameters are not (correctly) specified

getCrossreferenceById

public Crossreference getCrossreferenceById(CatalogVersion catver,
                                            String linkId)

Returns crossreference with the given catalogversion and id.

Parameters:

catver - catalog version (optional)

linkId - unique id of the crossreference

Returns:

The crossreference

setOrRemoveCrossreferences

public void setOrRemoveCrossreferences(SessionContext ctx,
                                       Item source,
                                       String attribute,
                                       Language language,
                                       String html)

Checks the given html text for new or removed crossreferences and updates the Crossreference object accordingly.

Parameters:

ctx - session context

html - The html text to be modified.

source -

attribute -

language -

getCrossreferencesForRemoving

public Collection<Crossreference> getCrossreferencesForRemoving(Item item)

This method returns all Crossreferences where either the target of the Crossreference is the given item or the source of the Crossreference.

Parameters:

item -