ucar.nc2.util

Class EscapeStrings

java.lang.Object

ucar.nc2.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
protected static java.lang.String	_allowableInDAP
protected static java.lang.String	_allowableInOGC
protected static java.lang.String	_allowableInUrl
protected static java.lang.String	_allowableInUrlQuery
protected static java.lang.String	_disallowedInOGC
protected static java.lang.String	_namAllowedInDAP
protected static java.lang.String	_namAllowedInOGC
protected static char	_URIEscape
protected static java.lang.String	alpha
protected static java.lang.String	alphaNumeric
protected static java.lang.String	dapSpecAllowed
protected static java.lang.String	httpclient_queryillegal
protected static java.lang.String	httpclient_querylegal
protected static java.lang.String	httpclient_urlillegal
protected static java.lang.String	httpclient_urllegal
static org.slf4j.Logger	log
protected static java.lang.String	nonAlphaNumeric
protected static java.lang.String	numeric
protected static java.lang.String	opendap_identifier_characters
protected static java.lang.String	opendap_identifier_special_characters
protected static java.lang.String	queryIdentAllowed
protected static java.lang.String	queryIdentDisallowed
protected static java.lang.String	queryReserved
protected static java.lang.String	urlAllowed
protected static java.lang.String	urlDisallowed
protected static java.lang.String	urlReserved

Constructor Summary

Constructors

Constructor and Description
EscapeStrings()

Method Summary

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	backslashEscapeDapString(java.lang.String s) Given a DAP (attribute) string, insert backslashes before '"' and '/' characters.
static java.lang.String	backslashToDAP(java.lang.String bs) Given a backslash escaped name, convert to a DAP escaped name
static java.lang.String	backslashUnescape(java.lang.String x) backslash unescape a string
static java.lang.String	escapeDAPIdentifier(java.lang.String s) Define the DAP escape identifier 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)
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	main2(java.lang.String[] args)
static void	mainOld(java.lang.String[] args)
static java.lang.String	normalizeToXML(java.lang.String s)
static void	testOGC()
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.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.slf4j.Logger log

alpha

protected static final java.lang.String alpha

See Also:

Constant Field Values

numeric

protected static final java.lang.String numeric

See Also:

Constant Field Values

alphaNumeric

protected static final java.lang.String alphaNumeric

See Also:

Constant Field Values

httpclient_urllegal

protected static final java.lang.String httpclient_urllegal

See Also:

Constant Field Values

httpclient_querylegal

protected static final java.lang.String httpclient_querylegal

See Also:

Constant Field Values

httpclient_urlillegal

protected static final java.lang.String httpclient_urlillegal

See Also:

Constant Field Values

httpclient_queryillegal

protected static final java.lang.String httpclient_queryillegal

See Also:

Constant Field Values

nonAlphaNumeric

protected static final java.lang.String nonAlphaNumeric

See Also:

Constant Field Values

queryReserved

protected static final java.lang.String queryReserved

See Also:

Constant Field Values

urlReserved

protected static final java.lang.String urlReserved

See Also:

Constant Field Values

urlDisallowed

protected static final java.lang.String urlDisallowed

See Also:

Constant Field Values

urlAllowed

protected static final java.lang.String urlAllowed

See Also:

Constant Field Values

_allowableInUrl

protected static final java.lang.String _allowableInUrl

See Also:

Constant Field Values

queryIdentDisallowed

protected static final java.lang.String queryIdentDisallowed

See Also:

Constant Field Values

queryIdentAllowed

protected static final java.lang.String queryIdentAllowed

See Also:

Constant Field Values

_allowableInUrlQuery

protected static final java.lang.String _allowableInUrlQuery

See Also:

Constant Field Values

dapSpecAllowed

protected static final java.lang.String dapSpecAllowed

See Also:

Constant Field Values

_namAllowedInDAP

protected static final java.lang.String _namAllowedInDAP

See Also:

Constant Field Values

_allowableInDAP

protected static final java.lang.String _allowableInDAP

See Also:

Constant Field Values

_namAllowedInOGC

protected static final java.lang.String _namAllowedInOGC

See Also:

Constant Field Values

_disallowedInOGC

protected static final java.lang.String _disallowedInOGC

See Also:

Constant Field Values

_allowableInOGC

protected static final java.lang.String _allowableInOGC

See Also:

Constant Field Values

opendap_identifier_special_characters

protected static final java.lang.String opendap_identifier_special_characters

See Also:

Constant Field Values

opendap_identifier_characters

protected static final java.lang.String opendap_identifier_characters

See Also:

Constant Field Values

_URIEscape

protected static final char _URIEscape

See Also:

Constant Field Values

Constructor Detail

EscapeStrings

public EscapeStrings()

Method Detail

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.

escapeURL

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

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.

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.

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

escapeDAPIdentifier

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

Define the DAP escape identifier function.

Parameters:

s - The string to encode.

Returns:

The escaped string.

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.

testOGC

public static void testOGC()

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; may be null

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 \\cha

Returns:

pos in string, or -1

main2

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

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

normalizeToXML

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

backslashToDAP

public static java.lang.String backslashToDAP(java.lang.String bs)

Given a backslash escaped name, convert to a DAP escaped name

Parameters:

bs - the string to DAP encode; may have backslash escapes

Returns:

escaped string

backslashEscapeDapString

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

Given a DAP (attribute) string, insert backslashes before '"' and '/' characters. This code also escapes control characters, although the spec does not call for it; make that code conditional.