cz.ues.platform.commons.uri

Class UESURI

java.lang.Object

cz.ues.platform.commons.uri.UESURI

All Implemented Interfaces:

URI

Direct Known Subclasses:

UESURI, UESURI.DeferrableUESURI

@XMLBindable
public class UESURI
extends java.lang.Object
implements URI

UESURI - Platform UES Uniform Resource Identifier. This class and its subclasses are immutable.

Since:

UES6-00

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UESURI.DeferrableUESURI Class used for definition of UESURI as constant.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	action UseCase action of this UESURI.
private UESURIPart	authority Authority of this UESURI.
private java.util.List<UESURIPart>	entityParts Entity part for this UESURI.
private java.lang.String	fragment Fragment of this UESURI.
protected static int	HC_INC Hash code step increment.
protected static int	HC_INIT Initial value for hash code.
private java.util.Map<java.lang.String,java.lang.Object>	parameters Parameters of this UESURI.
private java.lang.String	scheme Scheme of this UESURI.
static java.lang.String	SCHEME Scheme of this UESURI class.
private UESURIPart	territory Territory id of this UESURI.
private java.lang.String	uesuri The string representation of UESURI.
private UESURIPart	useCase UseCase id of this UESURI.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UESURI() Creates a new instance of UESURI.
(package private)	UESURI(java.lang.String aScheme, UESURIPart aAuthority, UESURIPart aTerritory, java.util.List<UESURIPart> aEntityParts, UESURIPart aUseCase, java.util.Map<java.lang.String,java.lang.Object> aParameters, java.lang.String aFragment) Creates a new instance of UESURI.
(package private)	UESURI(java.lang.String aScheme, UESURIPart aAuthority, UESURIPart aTerritory, java.util.List<UESURIPart> aEntityParts, UESURIPart aUseCase, java.lang.String aAction, java.util.Map<java.lang.String,java.lang.Object> aParameters, java.lang.String aFragment) Creates a new instance of UESURI.

Method Summary

Methods

Modifier and Type	Method and Description
private boolean	allUESURIPartsContainId() Checks that all UESURI parts in entity part contains Id.
static UESURI	deferrableParseURI(java.lang.String aString)
(package private) java.lang.String	entityPartListToString(java.util.List<UESURIPart> aPartList) Converts UESURI parts to string form.
boolean	equals(java.lang.Object aObject) Indicates whether some other object is also an UESURI equal to this one.
java.lang.String	getAction()
protected UESURIPart	getAuthority()
java.lang.String	getAuthorityCode()
java.lang.String	getAuthorityId()
java.lang.String	getEntityPart()
java.util.List<UESURIPart>	getEntityPartList() Return list of UESURIParts, which forms entity part.
java.lang.String	getFragment()
java.util.Map<java.lang.String,java.lang.Object>	getParameters()
protected java.lang.String	getParametersAsString() Returns parameters of this UESURI in string form.
java.lang.String	getScheme() Returns scheme of this URI.
java.lang.String	getSchemeSpecificPart() Returns scheme specific part.
protected UESURIPart	getTerritory()
java.lang.String	getTerritoryCode()
java.lang.String	getTerritoryId()
protected java.lang.String	getUESURI() Converts this instance to String form.
protected UESURIPart	getUseCase()
java.lang.String	getUseCaseCode()
java.lang.String	getUseCaseId()
int	hashCode()
private void	checkClassType() Tests, whether is invocation of this method performed only on instance of the class platform UESURI (not on a child implementation).
private boolean	isEmpty(java.util.List<UESURIPart> aEntityParts) Tests, whether contains the list of UESURI part mandatory entities.
private boolean	isEntityPartEqual(UESURI aOther) Checks, whether the entity part of the specified UESURI refers to the same entity as this UESURI.
private boolean	isSame(java.lang.String aFirst, java.lang.String aSecond) Test for equality of two strings.
static UESURI	parseURI(java.lang.String aString) Parses string into UESURI instance.
protected void	setUESURI(java.lang.String aValue) Initializes this instance according to purveyed UESURI in String form.
protected void	setUESURIInternal(java.lang.String aValue)
protected void	setUriParts(java.lang.String aScheme, UESURIPart aAuthority, UESURIPart aTerritory, java.util.List<UESURIPart> aEntityParts, UESURIPart aUseCase, java.util.Map<java.lang.String,java.lang.Object> aParameters, java.lang.String aFragment) Initializes values of this instance of UESURI.
protected void	setUriParts(java.lang.String aScheme, UESURIPart aAuthority, UESURIPart aTerritory, java.util.List<UESURIPart> aEntityParts, UESURIPart aUseCase, java.lang.String aAction, java.util.Map<java.lang.String,java.lang.Object> aParameters, java.lang.String aFragment) Initializes values of this instance of UESURI.
java.lang.String	toString()
private java.lang.String	toStringInternal() Creates string representation of this instance of UESURI.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HC_INIT

protected static final HC_INIT

Initial value for hash code.

See Also:

Constant Field Values

HC_INC

protected static final HC_INC

Hash code step increment.

See Also:

Constant Field Values

SCHEME

public static final SCHEME

Scheme of this UESURI class.

See Also:

Constant Field Values

scheme

private scheme

Scheme of this UESURI.

authority

private authority

Authority of this UESURI.

territory

private territory

Territory id of this UESURI.

entityParts

private entityParts

Entity part for this UESURI.

useCase

private useCase

UseCase id of this UESURI.

action

private action

UseCase action of this UESURI.

parameters

private parameters

Parameters of this UESURI.

fragment

private fragment

Fragment of this UESURI.

uesuri

private uesuri

The string representation of UESURI. The main purpose of this attribute is JAXB serialization when UESURI is used as type in WebServices.

Since:

UES6-00

Constructor Detail

UESURI

protected UESURI()

Creates a new instance of UESURI.

Since:

UES6-00

UESURI

UESURI(java.lang.String aScheme,
UESURIPart aAuthority,
UESURIPart aTerritory,
java.util.List<UESURIPart> aEntityParts,
UESURIPart aUseCase,
java.util.Map<java.lang.String,java.lang.Object> aParameters,
java.lang.String aFragment)

Creates a new instance of UESURI.

Parameters:

aScheme - UESURI scheme.

aAuthority - Authority part.

aTerritory - Territory scheme.

aEntityParts - Entity parts.

aUseCase - Use case part.

aParameters - Parameters.

aFragment - Fragment.

Since:

UES6-04

UESURI

UESURI(java.lang.String aScheme,
UESURIPart aAuthority,
UESURIPart aTerritory,
java.util.List<UESURIPart> aEntityParts,
UESURIPart aUseCase,
java.lang.String aAction,
java.util.Map<java.lang.String,java.lang.Object> aParameters,
java.lang.String aFragment)

Creates a new instance of UESURI.

Parameters:

aScheme - UESURI scheme.

aAuthority - Authority part.

aTerritory - Territory scheme.

aEntityParts - Entity parts.

aUseCase - Use case part.

aAction - Use case action.

aParameters - Parameters.

aFragment - Fragment.

Since:

UES8-08

Method Detail

setUESURI

protected void setUESURI(java.lang.String aValue)

Initializes this instance according to purveyed UESURI in String form.

Parameters:

aValue - UESURI in String form.

Since:

UES6-00

setUESURIInternal

protected void setUESURIInternal(java.lang.String aValue)

getUESURI

protected java.lang.String getUESURI()

Converts this instance to String form.

Returns:

this instance in String form.

Since:

UES6-00

getSchemeSpecificPart

public java.lang.String getSchemeSpecificPart()

Returns scheme specific part.

Specified by:

getSchemeSpecificPart in interface URI

Returns:

scheme specific part.

Since:

UES6-00

See Also:

URI.getSchemeSpecificPart()

entityPartListToString

java.lang.String entityPartListToString(java.util.List<UESURIPart> aPartList)

Converts UESURI parts to string form. Special characters in the result string are escaped.

Parameters:

aPartList - List of UESURI parts.

Returns:

String.

Since:

UES6-04

parseURI

public static UESURI parseURI(java.lang.String aString)
throws InvalidFormatRTException

Parses string into UESURI instance.

Parameters:

aString - Parsed string.

Returns:

UESURI instance.

Throws:

InvalidFormatRTException - When parsed string doesn't contain valid UESURI in String form.

Since:

UES6-00

equals

public boolean equals(java.lang.Object aObject)
throws InsufficientUESURIRTException

Indicates whether some other object is also an UESURI equal to this one. In order to compare, both UESURIs must be invariable. That means they must clearly and permanently identify one particular object. Such UESURI must have ID specified for territory and for all UESURI parts which form this UESURI. If either of UESURIs is not invariable, they cannot be compared and an exception is thrown. To check if UESURI is invariable and so can be compared, use method UESURIHelper.isInvariable. For comparison of ambiguous UESURIs use method UESURIHelper.isSame.

Overrides:

equals in class java.lang.Object

Throws:

InsufficientUESURIRTException

Since:

UES6-00

See Also:

Object.equals(java.lang.Object)

isEntityPartEqual

private boolean isEntityPartEqual(UESURI aOther)

Checks, whether the entity part of the specified UESURI refers to the same entity as this UESURI.

Parameters:

aOther - Compared UESURI.

Returns:

True, when entity part of this UESURI refers to the same entity as the entity part of the other UESURI.

Since:

UES6-04

isSame

private boolean isSame(java.lang.String aFirst,
java.lang.String aSecond)

Test for equality of two strings.

Parameters:

aFirst - First tested string.

aSecond - Second tested string.

Returns:

True, when both parameters are either null or equals, otherwise false.

Since:

UES6-04

checkClassType

private void checkClassType()

Tests, whether is invocation of this method performed only on instance of the class platform UESURI (not on a child implementation).

Since:

UES6-00

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Since:

UES6-00

See Also:

Object.hashCode()

allUESURIPartsContainId

private boolean allUESURIPartsContainId()

Checks that all UESURI parts in entity part contains Id.

Returns:

The value true if all UESURI parts contains Id. The value false if some UESURI part has no Id.

Since:

UES7-01

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Since:

UES6-00

See Also:

Object.toString()

getParametersAsString

protected java.lang.String getParametersAsString()

Returns parameters of this UESURI in string form.

Returns:

Parameters formatted to String form.

Since:

UES6-00

setUriParts

protected void setUriParts(java.lang.String aScheme,
UESURIPart aAuthority,
UESURIPart aTerritory,
java.util.List<UESURIPart> aEntityParts,
UESURIPart aUseCase,
java.util.Map<java.lang.String,java.lang.Object> aParameters,
java.lang.String aFragment)

Initializes values of this instance of UESURI.

Parameters:

aScheme - Scheme.

aAuthority - Authority part.

aTerritory - Territory part.

aEntityParts - Entity parts.

aUseCase - Use case part.

aParameters - Parameters.

aFragment - Fragment.

Since:

UES6-04

setUriParts

protected void setUriParts(java.lang.String aScheme,
UESURIPart aAuthority,
UESURIPart aTerritory,
java.util.List<UESURIPart> aEntityParts,
UESURIPart aUseCase,
java.lang.String aAction,
java.util.Map<java.lang.String,java.lang.Object> aParameters,
java.lang.String aFragment)

Initializes values of this instance of UESURI.

Parameters:

aScheme - Scheme.

aAuthority - Authority part.

aTerritory - Territory part.

aEntityParts - Entity parts.

aUseCase - Use case part.

aAction - Use case action.

aParameters - Parameters.

aFragment - Fragment.

Since:

UES8-08

isEmpty

private boolean isEmpty(java.util.List<UESURIPart> aEntityParts)

Tests, whether contains the list of UESURI part mandatory entities.

Parameters:

aEntityParts - List of UESURI entity parts.

Returns:

True, when the list contains valid UESURI part of entites, otherwise false.

Since:

UES6-04

toStringInternal

private java.lang.String toStringInternal()

Creates string representation of this instance of UESURI.

Returns:

This UESURI in String form.

Since:

UES6-00

getScheme

public java.lang.String getScheme()

Description copied from interface: URI

Returns scheme of this URI.

Specified by:

getScheme in interface URI

Returns:

scheme of this URI.

getAuthorityId

public java.lang.String getAuthorityId()

getAuthorityCode

public java.lang.String getAuthorityCode()

getTerritoryId

public java.lang.String getTerritoryId()

getTerritoryCode

public java.lang.String getTerritoryCode()

getEntityPart

public java.lang.String getEntityPart()

getEntityPartList

public java.util.List<UESURIPart> getEntityPartList()

Return list of UESURIParts, which forms entity part.

Returns:

list of UESURIParts, which forms entity part.

Since:

UES6-04

getUseCaseId

public java.lang.String getUseCaseId()

getUseCaseCode

public java.lang.String getUseCaseCode()

getAction

public java.lang.String getAction()

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

getFragment

public java.lang.String getFragment()

getAuthority

protected UESURIPart getAuthority()

getTerritory

protected UESURIPart getTerritory()

getUseCase

protected UESURIPart getUseCase()

deferrableParseURI

public static UESURI deferrableParseURI(java.lang.String aString)