com.epimorphics.lda.renderers.common

Class EldaURL

java.lang.Object

com.epimorphics.lda.renderers.common.EldaURL

public class EldaURL
extends Object

A decorator for the URL of an Elda page, which also provides mechanisms for manipulating the URL elements to produce related pages.

Author:

Ian Dickinson, Epimorphics (mailto:ian@epimorphics.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EldaURL.NamedParameterValue A pair of parameter name and value
static class	EldaURL.URLParameterValue A parameter value in the URL construction overall may have more than one value, with a comma separator

Constructor Summary

Constructors

Constructor and Description
EldaURL(String url) Construct an Elda page URL by parsing the given string as a URI
EldaURL(URI url) Construct an Elda page URL from the given URI object

Method Summary

Methods

Modifier and Type	Method and Description
protected EldaURL	generateURL(Map<String,EldaURL.URLParameterValue> parameters) Generate a URL that has the same structure as this URL, except for the given parameters.
EldaURL.URLParameterValue	getParameter(String paramName)
List<EldaURL.NamedParameterValue>	getParameters(boolean external) Return a list of URL parameters, possibly excluding those internal use parameters (i.e.
URI	getUri()
boolean	hasParameter(String paramName, String paramValue)
protected boolean	isInternalParameterName(String name)
protected Map<String,EldaURL.URLParameterValue>	parseQueryParameters() Parse the query string, if there is one, into a structure we can manipulate
protected String	queryString(Map<String,EldaURL.URLParameterValue> qParams) Turn the parsed query parameters back into a string
String	toString()
protected void	updateParameters(Map<String,EldaURL.URLParameterValue> parameters, String paramName, EldaURL.URLParameterValue value) Use the given value to update the parameters.
EldaURL	withParameter(com.epimorphics.lda.renderers.common.EldaURL.OPERATION op, String paramName, String paramValue) Create a new EldaURL by applying an operation to this URL to add, remove or set a parameter value.
EldaURL	withParameter(String op, String paramName, String paramValue) Create a new EldaURL by applying an operation to this URL to add, remove or set a parameter value.

Methods inherited from class java.lang.Object

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

Constructor Detail

EldaURL

public EldaURL(String url)

Construct an Elda page URL by parsing the given string as a URI

Parameters:

url - String denoting the page URL

Throws:

EldaException - if the given string is not a legal URI

EldaURL

public EldaURL(URI url)

Construct an Elda page URL from the given URI object

Parameters:

url -

Method Detail

withParameter

public EldaURL withParameter(String op,
                    String paramName,
                    String paramValue)

Create a new EldaURL by applying an operation to this URL to add, remove or set a parameter value.

Parameters:

op - The operation as a string

paramName - The name of the parameter (e.g. _properties)

paramValue - The value to be used with the operation

Returns:

A new EldaURL object

See Also:

withParameter(OPERATION, String, String)

withParameter

public EldaURL withParameter(com.epimorphics.lda.renderers.common.EldaURL.OPERATION op,
                    String paramName,
                    String paramValue)

Create a new EldaURL by applying an operation to this URL to add, remove or set a parameter value.

Parameters:

op - The operation: ADD ensures that the parameter has the value, REMOVE ensures that the parameter does not have the value, and SET ensures that the parameter has only that value

paramName - The name of the parameter (e.g. _properties)

paramValue - The value to be used with the operation

Returns:

A new EldaURL object

hasParameter

public boolean hasParameter(String paramName,
                   String paramValue)

Returns:

True if the URL already has the given parameter/value pair

getParameter

public EldaURL.URLParameterValue getParameter(String paramName)

Returns:

The value of the given parameter to the URL, or null

getParameters

public List<EldaURL.NamedParameterValue> getParameters(boolean external)

Return a list of URL parameters, possibly excluding those internal use parameters (i.e. that start with an underscore character).

Parameters:

external - If true, remove internal-use parameters

Returns:

A non-null but possibly empty list of current URL parameter values

toString

public String toString()

Overrides:

toString in class Object

getUri

public URI getUri()

Returns:

The encapsulated URI object

updateParameters

protected void updateParameters(Map<String,EldaURL.URLParameterValue> parameters,
                    String paramName,
                    EldaURL.URLParameterValue value)

Use the given value to update the parameters. If value is empty, remove the paramName key.

Parameters:

parameters - The parameters map to be updated

paramName - The parameter key

value - The revised value

parseQueryParameters

protected Map<String,EldaURL.URLParameterValue> parseQueryParameters()

Parse the query string, if there is one, into a structure we can manipulate

queryString

protected String queryString(Map<String,EldaURL.URLParameterValue> qParams)

Turn the parsed query parameters back into a string

generateURL

protected EldaURL generateURL(Map<String,EldaURL.URLParameterValue> parameters)

Generate a URL that has the same structure as this URL, except for the given parameters.

Parameters:

parameters - Parameters of the new URL object, as a map

Returns:

A new URL object

isInternalParameterName

protected boolean isInternalParameterName(String name)

Returns:

True if the parameter name denotes an internal name, starting with an underscore