senselogic.sitevision.api.text

Interface EndecUtil

@Requireable(value="EndecUtil")
public interface EndecUtil

Utility interface for encoding/decoding ("encode/decode" / "escape/unescape").

An instance of the SiteVision class implementing this interface can be obtained via Utils.getEndecUtil(). See Utils for how to obtain an instance of the Utils interface.

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
String	base64decode(String aString) Decodes a base64 encoded string
String	base64encode(String aString) Encodes a string using base64 encoding
String	br(String aString) Converts line breaks to xhtml <br /> elements.
String	decodeURL(String aURL) Decodes a URL safe String into its original form using the default charset.
String	encodeURL(String aURL) Encodes a String into its URL safe form using the default charset.
String	escapeIdentifier(String aPrefix, String anIdentifier) Escapes/encodes an identifier.
String	escapeJcrName(String aJcrName) Escapes/encodes a jcr name (property name or node name) that might contain illegal characters.
String	escapeXML(String aString) Escapes/encodes the characters in a String using XML entities.
String	getBaseSubstitute(String aString) Replaces characters to their base subtitute.
String	unEscapeHTML4(String aString) Unescapes/decodes a string containing HTML 4 entities to a string containing the actual Unicode characters corresponding to the entities.
String	unEscapeIdentifier(String aPrefix, String anIdentifier) Unescapes/decodes an escaped/encoded identifier.
String	unEscapeJcrName(String aJcrName) Unescapes/decodes a jcr name (property name or node name) that might be escape/encoded.
String	unEscapeXML(String aString) Unescapes/decodes a string containing basic XML entities to a string containing the actual Unicode characters corresponding to the entities.

Method Detail

escapeXML

String escapeXML(String aString)

Escapes/encodes the characters in a String using XML entities.

   Example: "One <br /> & two" -> "One &lt;br /&gt; &amp; two"
 

Parameters:

aString - a String that needs to be escaped

Returns:

aString escaped

unEscapeXML

String unEscapeXML(String aString)

Unescapes/decodes a string containing basic XML entities to a string containing the actual Unicode characters corresponding to the entities.

Supports the 5 basic XML entities (gt, lt, quot, amp, apos) and numerical unicodes (decimal and hex).

Examples:

[ One <br /> & two ] will become:
[ One <br /> & two ]

[ "Hej å hå" är kopieringsskyddat© sägs det ] will become:
[ "Hej å hå" är kopieringsskyddat© sägs det ]

Parameters:

aString - a String that contains escaped xml entities

Returns:

aString unescaped

See Also:

unEscapeHTML4(String)

unEscapeHTML4

String unEscapeHTML4(String aString)

Unescapes/decodes a string containing HTML 4 entities to a string containing the actual Unicode characters corresponding to the entities.

Supports HTML 4.0 entities, including numerical unicodes (decimal and hex).

Examples:

[ One <br /> & two ] will become:
[ One <br /> & two ]

[ "Hej å hå" är kopieringsskyddat© sägs det ] will become:
[ "Hej å hå" är kopieringsskyddat© sägs det ]

Parameters:

aString - a String that contains escaped html 4 entities

Returns:

aString unescaped

Since:

SiteVision 2.6.2

See Also:

unEscapeXML(String)

encodeURL

String encodeURL(String aURL)

Encodes a String into its URL safe form using the default charset.

Handles the www-form-urlencoded encoding scheme, also misleadingly known as URL encoding

Parameters:

aURL - the string to convert to a URL safe form

Returns:

an URL safe String. Returns null if aURL is null or can't be encoded.

Since:

SiteVision 2.6.1_04

decodeURL

String decodeURL(String aURL)

Decodes a URL safe String into its original form using the default charset.

Handles the www-form-urlencoded encoding scheme, also misleadingly known as URL encoding

Parameters:

aURL - URL safe String to convert to its original form

Returns:

a decoded String. Returns null if aURL is null or can't be decoded.

Since:

SiteVision 2.6.1_04

br

String br(String aString)

Converts line breaks to xhtml <br /> elements.

   Example: "Line 1\nLine 2" -> "Line 1<br />Line2"
 

Parameters:

aString - a String to convert

Returns:

aString the converted string

getBaseSubstitute

String getBaseSubstitute(String aString)

Replaces characters to their base subtitute. A name that is base substituted ensures that the name is CSS valid. Can for instance be used to get valid names for anchors (anchor links).

   Example: "xml ëBå_$-1205" -> "xmleBa1205"
 

Parameters:

aString - a String that should be base substituted

Returns:

the base substitute for aString

escapeJcrName

String escapeJcrName(String aJcrName)

Escapes/encodes a jcr name (property name or node name) that might contain illegal characters.

Any operation that includes a JCR name that contains illegal characters must be escaped. For example:

 javax.jcr.Node aNode = ...

 javax.jcr.NodeIterator aNodeIterator = aNode.getNodes("aNameThatShouldBeEscaped");
 javax.jcr.Property aProperty = aNode.getProperty("aNameThatShouldBeEscaped");
 

Illegal characters are:

• . ("dot")
• [ ("left bracket")
• ] ("right bracket")
• / ("slash")
• * ("asterix")
• | ("pipe")

Parameters:

aJcrName - a name that should be escaped/encoded

Returns:

aJcrName escaped/encoded

unEscapeJcrName

String unEscapeJcrName(String aJcrName)

Unescapes/decodes a jcr name (property name or node name) that might be escape/encoded.

Any operation that includes getting a JCR name must be unescaped if it contains illegal characters. For example:

 javax.jcr.Node aNode = ...
 javax.jcr.Property aProperty = ...

 java.lang.String aNameThatNeedsToBeUnEscaped = aNode.getName();
 java.lang.String anotherNameThatNeedsToBeUnEscaped = aProperty.getName();
 

Parameters:

aJcrName - a name that might be escaped/encoded

Returns:

aJcrName unescaped/decoded

base64encode

String base64encode(String aString)

Encodes a string using base64 encoding

Parameters:

aString - a String that should be base64 encoded

Returns:

aString base64 encoded. Returns null if aString is null

Since:

SiteVision 2.6

base64decode

String base64decode(String aString)

Decodes a base64 encoded string

Parameters:

aString - a base64 encoded String

Returns:

aString base64 decoded. Returns null if aString is null or can't be decoded.

Since:

SiteVision 2.6

escapeIdentifier

String escapeIdentifier(String aPrefix,
                        String anIdentifier)

Escapes/encodes an identifier.

Some examples

aPrefix	anIdentifier	Returned
null	null	""
""	null	""
null	""	""
""	""	""
"pcx"	null	"pcx"
null	"pcx"	"pcx"
"pcx"	""	"pcx"
"pcx"	"123"	"pcx123"
"pcx"	"1.23"	"pcx1_23"
"pcx"	"1.23.45"	"pcx1_23_45"

Parameters:

aPrefix - a prefix added to the result

anIdentifier - a string id

Returns:

a non-null prefixed and escaped string identifier

Since:

SiteVision 3.0.2

unEscapeIdentifier

String unEscapeIdentifier(String aPrefix,
                          String anIdentifier)

Unescapes/decodes an escaped/encoded identifier.

Some examples

aPrefix	anIdentifier	Returned
null	null	""
""	null	""
null	""	""
""	""	""
"pcx"	null	""
null	"pcx"	"pcx"
"pcx"	""	""
"pcx"	"pcx123"	"123"
"pcx"	"pcx1_23"	"1.23"
"pcx"	"pcx1_23_45"	"1.23.45"
null	"pcx1_23"	"pcx1.23"
""	"pcx1_23"	"pcx1.23"
"badprefix"	"pcx1_23"	"pcx1.23"

Parameters:

aPrefix - a prefix that will be removed from the result

anIdentifier - a string id

Returns:

an unescaped non-null identifier

Since:

SiteVision 3.0.2