Package org.hippoecm.frontend.util

Class CodecUtils

java.lang.Object

org.hippoecm.frontend.util.CodecUtils

public class CodecUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENCODING_DISPLAY
static String	ENCODING_NODE
static org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor	Description
CodecUtils()

Method Summary

Modifier and Type	Method	Description
static StringCodec	getDisplayNameCodec(IPluginContext context)	Lookup a StringCodec for encoding/decoding a display name.
static String	getLocaleFromDocumentOrFolder(Node document, Node folder)	Helper method for fetching a locale for a document or a folder.
static String	getLocaleFromNode(Node node)
static String	getLocaleFromNodeAndAncestors(Node node)	Return the value of property HippoTranslationNodeType.LOCALE for the first translated node found.
static StringCodec	getNodeNameCodec(IPluginContext context, String locale)	Lookup a StringCodec for encoding/decoding a node name for a specific locale (optional).
static StringCodec	getNodeNameCodec(IPluginContext context, Node node)	Lookup a StringCodec for encoding/decoding a node name.
static org.apache.wicket.model.IModel<StringCodec>	getNodeNameCodecModel(IPluginContext context, String locale)	Convenience method for wrapping a StringCodec in a LoadableDetachableModel.
static StringCodecFactory	getStringCodecFactory(IPluginContext context)	Return a StringCodecFactory from the ISettingsService or throw an IllegalStateException if not found.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.slf4j.Logger log

ENCODING_NODE

public static final String ENCODING_NODE

See Also:

Constant Field Values

ENCODING_DISPLAY

public static final String ENCODING_DISPLAY

See Also:

Constant Field Values

Constructor Detail

CodecUtils

public CodecUtils()

Method Detail

getStringCodecFactory

public static StringCodecFactory getStringCodecFactory(IPluginContext context)

Return a StringCodecFactory from the ISettingsService or throw an IllegalStateException if not found.

Parameters:

context - The IPluginContext should contain a reference to the ISettingsService, otherwise an IllegalStateException is thrown.

Returns:

a StringCodecFactory if found, otherwise an IllegalStateException is thrown.

getDisplayNameCodec

public static StringCodec getDisplayNameCodec(IPluginContext context)

Lookup a StringCodec for encoding/decoding a display name.

Parameters:

context - Used for retrieving the StringCodecFactory, see getStringCodecFactory(org.hippoecm.frontend.plugin.IPluginContext)

Returns:

a StringCodec for encoding/decoding a display name.

getNodeNameCodec

public static StringCodec getNodeNameCodec(IPluginContext context,
                                           String locale)

Lookup a StringCodec for encoding/decoding a node name for a specific locale (optional).

Parameters:

context - Used for retrieving the StringCodecFactory, see getStringCodecFactory(org.hippoecm.frontend.plugin.IPluginContext)

locale - Simplified string representation of a locale like en_US or de

Returns:

a StringCodec for encoding/decoding a node name.

getNodeNameCodec

public static StringCodec getNodeNameCodec(IPluginContext context,
                                           Node node)

Lookup a StringCodec for encoding/decoding a node name. The Node is used for retrieving an optional locale.

Parameters:

context - Used for retrieving the StringCodecFactory, see getStringCodecFactory(org.hippoecm.frontend.plugin.IPluginContext)

node - If the node or any of its parents have property HippoTranslationNodeType.LOCALE set, the value is used to localize the StringCodec.

Returns:

a StringCodec for encoding/decoding a node name.

getNodeNameCodecModel

public static org.apache.wicket.model.IModel<StringCodec> getNodeNameCodecModel(IPluginContext context,
                                                                                String locale)

Convenience method for wrapping a StringCodec in a LoadableDetachableModel. See getNodeNameCodec(IPluginContext, String)

Parameters:

context - Used for retrieving the StringCodecFactory, see getStringCodecFactory(org.hippoecm.frontend.plugin.IPluginContext)

locale - Simplified string representation of a locale like en_US or de

Returns:

A LoadableDetachableModel wrapping a StringCodec for encoding/decoding a node name.

getLocaleFromNodeAndAncestors

public static String getLocaleFromNodeAndAncestors(Node node)

Return the value of property HippoTranslationNodeType.LOCALE for the first translated node found. If the provided node is a handle, start with the first child to check whether there is a HippoTranslationNodeType.LOCALE property Traverse up the ancestor tree until a locale is found.

Parameters:

node - Node to start traversal with

Returns:

String representation of locale associated with subtree

getLocaleFromNode

public static String getLocaleFromNode(Node node)

getLocaleFromDocumentOrFolder

public static String getLocaleFromDocumentOrFolder(Node document,
                                                   Node folder)

Helper method for fetching a locale for a document or a folder.