cz.ues.core.commons.uri

Class UESURI

java.lang.Object

cz.ues.platform.commons.uri.UESURI

cz.ues.core.commons.uri.UESURI

All Implemented Interfaces:

URI

Direct Known Subclasses:

UESURI.DeferrableUESURI

@XMLBindable
public class UESURI
extends UESURI

UESURI - UES Uniform Resource Identifier - Core implementation.

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 UESURIPart	artifact Artifact ID of this UESURI.
private static UESURIPart	NULL_PART This UESURIPart refers to non-existent object.
static UESURI	NULL_URI Null object for UESURI.
private UESURIPart	object Object ID of this UESURI.
static java.lang.String	SCHEME Scheme of this UESURI class.

Fields inherited from class cz.ues.platform.commons.uri.UESURI

HC_INC, HC_INIT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UESURI() Creates a new instance of UESURI.
(package private)	UESURI(java.lang.String aScheme, UESURIPart aRole, UESURIPart aTerritory, UESURIPart aArtifact, UESURIPart aObject, 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 aRole, UESURIPart aTerritory, UESURIPart aArtifact, UESURIPart aObject, 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
static UESURI	deferrableParseURI(java.lang.String aString)
boolean	equals(java.lang.Object aObject) Indicates whether some other object is also an UESURI equal to this one.
protected UESURIPart	getArtifact() Returns artifact.
java.lang.String	getArtifactCode() Returns artifact code.
java.lang.String	getArtifactId() Returns artifact Id.
java.lang.String	getEntityPart()
protected UESURIPart	getObject() Returns object.
java.lang.String	getObjectCode() Returns object code.
java.lang.String	getObjectId() Returns object Id.
protected UESURIPart	getRole() Returns role.
java.lang.String	getRoleCode() Returns role code.
java.lang.String	getRoleId() Returns role Id.
int	hashCode()
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	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) Deprecated. use #setUriParts(String, String, String, String, String, String, String, String, String, String, String, Map, String) instead.
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) Deprecated. use #setUriParts(String, String, String, String, String, String, String, String, String, String, String, String, Map, String) instead.
protected void	setUriParts(java.lang.String aScheme, UESURIPart aRole, UESURIPart aTerritory, UESURIPart aArtifact, UESURIPart aObject, UESURIPart aUseCase, java.util.Map<java.lang.String,java.lang.Object> aParameters, java.lang.String aFragment) Initializes instance attributes.
protected void	setUriParts(java.lang.String aScheme, UESURIPart aRole, UESURIPart aTerritory, UESURIPart aArtifact, UESURIPart aObject, UESURIPart aUseCase, java.lang.String aAction, java.util.Map<java.lang.String,java.lang.Object> aParameters, java.lang.String aFragment) Initializes instance attributes.

Methods inherited from class cz.ues.platform.commons.uri.UESURI

getAction, getAuthority, getAuthorityCode, getAuthorityId, getEntityPartList, getFragment, getParameters, getParametersAsString, getScheme, getSchemeSpecificPart, getTerritory, getTerritoryCode, getTerritoryId, getUESURI, getUseCase, getUseCaseCode, getUseCaseId, setUESURIInternal, toString

Methods inherited from class java.lang.Object

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

Field Detail

SCHEME

public static final SCHEME

Scheme of this UESURI class.

See Also:

Constant Field Values

NULL_PART

private static final NULL_PART

This UESURIPart refers to non-existent object.

NULL_URI

public static final NULL_URI

Null object for UESURI. It is similar to an empty String. Typical usage is in the UES API when it is needed to represent empty value.

artifact

private artifact

Artifact ID of this UESURI.

object

private object

Object ID of this UESURI.

Constructor Detail

UESURI

protected UESURI()

Creates a new instance of UESURI.

Since:

UES6-00

UESURI

UESURI(java.lang.String aScheme,
UESURIPart aRole,
UESURIPart aTerritory,
UESURIPart aArtifact,
UESURIPart aObject,
UESURIPart aUseCase,
java.util.Map<java.lang.String,java.lang.Object> aParameters,
java.lang.String aFragment)

Creates a new instance of UESURI.

Parameters:

aScheme - Scheme of created UESURI.

aRole - Role of created UESURI.

aTerritory - Territory of created UESURI.

aArtifact - Artifact of created UESURI.

aObject - Object of created UESURI.

aUseCase - Use case of created UESURI.

aParameters - Parameters of created UESURI.

aFragment - Fragment of created UESURI.

Since:

UES6-04

UESURI

UESURI(java.lang.String aScheme,
UESURIPart aRole,
UESURIPart aTerritory,
UESURIPart aArtifact,
UESURIPart aObject,
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 - Scheme of created UESURI.

aRole - Role of created UESURI.

aTerritory - Territory of created UESURI.

aArtifact - Artifact of created UESURI.

aObject - Object of created UESURI.

aUseCase - Use case of created UESURI.

aAction - Use case action of created UESURI.

aParameters - Parameters of created UESURI.

aFragment - Fragment of created UESURI.

Since:

UES8-08

Method Detail

setUESURI

protected void setUESURI(java.lang.String aValue)

Initializes this instance according to purveyed UESURI in String form.

Overrides:

setUESURI in class UESURI

Parameters:

aValue - UESURI in String form.

Since:

UES6-00

See Also:

UESURI.setUESURI(java.lang.String)

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 InvalidFormatRTException

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, artifact and object (if one is present). 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 UESURI

Throws:

InvalidFormatRTException

Since:

UES6-00

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class UESURI

Since:

UES6-00

See Also:

UESURI.hashCode()

setUriParts

@Deprecated

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)

Deprecated. use #setUriParts(String, String, String, String, String, String, String, String, String, String, String, Map, String) instead.

Initializes values of this instance of UESURI.

Overrides:

setUriParts in class UESURI

Parameters:

aScheme - Scheme.

aAuthority - Authority part.

aTerritory - Territory part.

aEntityParts - Entity parts.

aUseCase - Use case part.

aParameters - Parameters.

aFragment - Fragment.

Since:

UES6-00

See Also:

cz.ues.platform.commons.uri.UESURI#setUriParts(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map, java.lang.String)

setUriParts

@Deprecated

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)

Deprecated. use #setUriParts(String, String, String, String, String, String, String, String, String, String, String, String, Map, String) instead.

Initializes values of this instance of UESURI.

Overrides:

setUriParts in class 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

See Also:

cz.ues.platform.commons.uri.UESURI#setUriParts(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map, java.lang.String)

setUriParts

protected void setUriParts(java.lang.String aScheme,
UESURIPart aRole,
UESURIPart aTerritory,
UESURIPart aArtifact,
UESURIPart aObject,
UESURIPart aUseCase,
java.util.Map<java.lang.String,java.lang.Object> aParameters,
java.lang.String aFragment)
throws InvalidFormatRTException

Initializes instance attributes.

Parameters:

aScheme - Scheme of created UESURI.

aRole - Role of created UESURI.

aTerritory - Territory of created UESURI.

aArtifact - Artifact of created UESURI.

aObject - Object of created UESURI.

aUseCase - Use case of created UESURI.

aParameters - Parameters of created UESURI.

aFragment - Fragment of created UESURI.

Throws:

InvalidFormatRTException - When territory or artifact UESURIPart is either missing or empty.

Since:

UES6-04

setUriParts

protected void setUriParts(java.lang.String aScheme,
UESURIPart aRole,
UESURIPart aTerritory,
UESURIPart aArtifact,
UESURIPart aObject,
UESURIPart aUseCase,
java.lang.String aAction,
java.util.Map<java.lang.String,java.lang.Object> aParameters,
java.lang.String aFragment)
throws InvalidFormatRTException

Initializes instance attributes.

Parameters:

aScheme - Scheme of created UESURI.

aRole - Role of created UESURI.

aTerritory - Territory of created UESURI.

aArtifact - Artifact of created UESURI.

aObject - Object of created UESURI.

aUseCase - Use case of created UESURI.

aAction - Use case action of created UESURI.

aParameters - Parameters of created UESURI.

aFragment - Fragment of created UESURI.

Throws:

InvalidFormatRTException - When territory or artifact UESURIPart is either missing or empty.

Since:

UES8-08

getEntityPart

public java.lang.String getEntityPart()

Overrides:

getEntityPart in class UESURI

Since:

UES6-00

See Also:

UESURI.getEntityPart()

getRoleId

public java.lang.String getRoleId()

Returns role Id.

Returns:

role Id.

Since:

UES6-00

getRoleCode

public java.lang.String getRoleCode()

Returns role code.

Returns:

role code.

Since:

UES6-00

getArtifactId

public java.lang.String getArtifactId()

Returns artifact Id.

Returns:

artifact Id.

Since:

UES6-00

getArtifactCode

public java.lang.String getArtifactCode()

Returns artifact code.

Returns:

artifact code.

Since:

UES6-00

getObjectId

public java.lang.String getObjectId()

Returns object Id.

Returns:

object Id.

Since:

UES6-00

getObjectCode

public java.lang.String getObjectCode()

Returns object code.

Returns:

object code.

Since:

UES6-00

getRole

protected UESURIPart getRole()

Returns role.

Returns:

role.

Since:

UES6-06

getArtifact

protected UESURIPart getArtifact()

Returns artifact.

Returns:

artifact.

Since:

UES6-04

getObject

protected UESURIPart getObject()

Returns object.

Returns:

object.

Since:

UES6-04

deferrableParseURI

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