ucar.unidata.util

Class EscapeStrings

java.lang.Object

ucar.unidata.util.EscapeStrings

public class EscapeStrings
extends java.lang.Object

User: ndp Date: Jul 7, 2006 Time: 10:23:19 AM

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_allowableInOGC
static java.lang.String	_allowableInUrl
static java.lang.String	_allowableInUrlQuery
static java.lang.String	asciiAlphaNumeric
static java.lang.String	asciiNonAlphaNumeric
static java.lang.String	opendap_identifier_characters
static java.lang.String	opendap_identifier_special_characters

Constructor Summary

Constructors

Constructor and Description
EscapeStrings()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	backslashEscape(java.lang.String x, java.lang.String reservedChars) backslash escape a string
static java.lang.String	backslashUnescape(java.lang.String x) backslash unescape a string
static java.lang.String	escapeDAPIdentifier(java.lang.String id) Define the DEFINITIVE opendap identifier escape function.
static java.lang.String	escapeOGC(java.lang.String s) Define the OGC Web Services escape function.
static java.lang.String	escapeURL(java.lang.String url) Decompose a url and piecemeal encode all of its parts, including query and fragment
static java.lang.String	escapeURLQuery(java.lang.String ce) Define the DEFINITIVE URL constraint expression escape function.
static int	indexOf(java.lang.String escapedName, char c) Find first occurence of char c in escapedName, excluding escaped c.
static void	main(java.lang.String[] args)
static void	mainOld(java.lang.String[] args)
static java.lang.String	normalizeToXML(java.lang.String s) This method is used to normalize strings prior to their inclusion in XML documents.
static java.lang.String[]	splitURL(java.lang.String url) Split a url into the base plus the query
static java.util.List<java.lang.String>	tokenizeEscapedName(java.lang.String escapedName) Tokenize an escaped name using "." as delimiter, skipping "\."
static java.lang.String	unEscapeDAPIdentifier(java.lang.String id) Define the DEFINITIVE opendap identifier unescape function.
static java.lang.String	unescapeOGC(java.lang.String s) Define the OGC unescape function.
static java.lang.String	unescapeURL(java.lang.String url) Decode all of the parts of the url including query and fragment
static java.lang.String	unescapeURLQuery(java.lang.String ce) Define the DEFINITIVE URL constraint expression unescape function.
static java.lang.String	urlDecode(java.lang.String s) Define the DEFINITIVE URL unescape function.
static java.lang.String	urlEncode(java.lang.String s) Define the DEFINITIVE URL escape function.

Methods inherited from class java.lang.Object

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

Field Detail

asciiAlphaNumeric

public static java.lang.String asciiAlphaNumeric

asciiNonAlphaNumeric

public static java.lang.String asciiNonAlphaNumeric

_allowableInUrlQuery

public static java.lang.String _allowableInUrlQuery

_allowableInUrl

public static java.lang.String _allowableInUrl

_allowableInOGC

public static java.lang.String _allowableInOGC

opendap_identifier_special_characters

public static java.lang.String opendap_identifier_special_characters

opendap_identifier_characters

public static java.lang.String opendap_identifier_characters

Constructor Detail

EscapeStrings

public EscapeStrings()

Method Detail

normalizeToXML

public static java.lang.String normalizeToXML(java.lang.String s)

This method is used to normalize strings prior to their inclusion in XML documents. XML has certain parsing requirements around reserved characters. These reserved characters must be replaced with symbols recognized by the XML parser as place holder for the actual symbol.

The rule for this normalization is as follows:

• The < (less than) character is replaced with &lt;
• The > (greater than) character is replaced with &gt;
• The & (ampersand) character is replaced with &amp;
• The ' (apostrophe) character is replaced with &apos;
• The " (double quote) character is replaced with &quot;

Parameters:

s - The String to be normalized.

Returns:

The normalized String.

splitURL

public static java.lang.String[] splitURL(java.lang.String url)

Split a url into the base plus the query

Parameters:

url - The expression to unescape.

Returns:

The base and url as a 2 element string array.

escapeDAPIdentifier

public static java.lang.String escapeDAPIdentifier(java.lang.String id)

Define the DEFINITIVE opendap identifier escape function.

Parameters:

id - The identifier to modify.

Returns:

The escaped identifier.

unEscapeDAPIdentifier

public static java.lang.String unEscapeDAPIdentifier(java.lang.String id)

Define the DEFINITIVE opendap identifier unescape function.

Parameters:

id - The identifier to unescape.

Returns:

The unescaped identifier.

escapeURLQuery

public static java.lang.String escapeURLQuery(java.lang.String ce)

Define the DEFINITIVE URL constraint expression escape function.

Parameters:

ce - The expression to modify.

Returns:

The escaped expression.

unescapeURLQuery

public static java.lang.String unescapeURLQuery(java.lang.String ce)

Define the DEFINITIVE URL constraint expression unescape function.

Parameters:

ce - The expression to unescape.

Returns:

The unescaped expression.

urlEncode

public static java.lang.String urlEncode(java.lang.String s)

Define the DEFINITIVE URL escape function. Note that the whole string is escaped, so be careful what you pass into this procedure.

Parameters:

s - The string to modify.

Returns:

The escaped expression.

urlDecode

public static java.lang.String urlDecode(java.lang.String s)

Define the DEFINITIVE URL unescape function.

Parameters:

s - The string to unescape.

Returns:

The unescaped expression.

escapeURL

public static java.lang.String escapeURL(java.lang.String url)

Decompose a url and piecemeal encode all of its parts, including query and fragment

Parameters:

url - the url to encode

unescapeURL

public static java.lang.String unescapeURL(java.lang.String url)

Decode all of the parts of the url including query and fragment

Parameters:

url - the url to encode

escapeOGC

public static java.lang.String escapeOGC(java.lang.String s)

Define the OGC Web Services escape function.

Parameters:

s - The string to encode.

Returns:

The escaped string.

unescapeOGC

public static java.lang.String unescapeOGC(java.lang.String s)

Define the OGC unescape function.

Parameters:

s - The string to unescape. b

Returns:

The unescaped string.

backslashEscape

public static java.lang.String backslashEscape(java.lang.String x,
                               java.lang.String reservedChars)

backslash escape a string

Parameters:

x - escape this

reservedChars - these chars get a backslash in front of them

Returns:

escaped string

backslashUnescape

public static java.lang.String backslashUnescape(java.lang.String x)

backslash unescape a string

Parameters:

x - unescape this

Returns:

string with \c -> c

tokenizeEscapedName

public static java.util.List<java.lang.String> tokenizeEscapedName(java.lang.String escapedName)

Tokenize an escaped name using "." as delimiter, skipping "\."

Parameters:

escapedName - an escaped name

Returns:

list of tokens

indexOf

public static int indexOf(java.lang.String escapedName,
          char c)

Find first occurence of char c in escapedName, excluding escaped c.

Parameters:

escapedName - search in this string

c - for this char but not \\char

Returns:

pos in string, or -1

main

public static void main(java.lang.String[] args)

mainOld

public static void mainOld(java.lang.String[] args)
                    throws java.lang.Exception

Throws:

java.lang.Exception