cz.ues.core.commons.uri

Interface UESURIConvertor

All Superinterfaces:

UESURIConvertor

@UESComponent
public interface UESURIConvertor
extends UESURIConvertor

UESURIConverter - this components support working with UESURI. TODO Jmeno tehle tridy je zavadejici - puvodni myslenka byla, ze bude prevadet UESURI do jinych forem (napr. UESURI na normalizovanou UESURI), ale pak byly pridany parove metody (getNormalizedURI() - isNormalized() ), proto uz neni jeji nazev (Convertor) nejstastnejsi.

Since:

UES6-00

Method Summary

Methods

Modifier and Type	Method and Description
UESURI	convertToCoreURI(UESURI uri) Converts platform UESURI to core UESURI.
UESURI	getCanonicalURI(UESURI uri) Returns canonical UESURI.
UESURI	getCodeBasedURI(UESURI uri) Returns UESURI containing only codes.
UESURI	getEvaluatedURI(UESURI uri) Returns evaluated UESURI.
UESURI	getNormalizedURI(UESURI uri) Returns normalized UESURI.
UESURI	getNormalizedURI(UESURI uri, boolean forceRefresh) Returns normalized UESURI.
boolean	isCanonical(UESURI uri) Tests, whether is the UESURI in canonical form.
boolean	isCodeBased(UESURI uri) Tests whether the UESURI contains only codes, see details about code-based UESURI in UESURIConvertor.getCodeBasedURI(UESURI).
boolean	isEvaluated(UESURI uri) Tests whether is the UESURI evaluated (expressions are resolved).
boolean	isNormalized(UESURI uri) Tests, whether is the UESURI in normalized form.

Methods inherited from interface cz.ues.platform.commons.uri.UESURIConvertor

getCanonicalURI, getEvaluatedURI, getNormalizedURI, isCanonical, isEvaluated, isNormalized

Method Detail

getNormalizedURI

UESURI getNormalizedURI(UESURI uri)
throws InvalidUESURIFormatRTException

Returns normalized UESURI. Normalized form of UESURI is described in artifact UNI-BT:UES.DOC/URI_V2/HLC.

Normalization of an UESURI requires that active territory is the same as territory specified within the normalized UESURI.

Parameters:

uri - UESURI for normalization.

Returns:

Normalized UESURI or the null reference if the UESURI cannot be normalized (e.g. the UESURI is ambiguous; there is no persistent object referenced by the UESURI,...).

Throws:

InvalidUESURIFormatRTException - If UESURI cannot be normalized due to invalid format.

Since:

UES6-00

See Also:

UESTerritoryService

getNormalizedURI

UESURI getNormalizedURI(UESURI uri,
boolean forceRefresh)
throws InvalidUESURIFormatRTException

Returns normalized UESURI. Normalized form of UESURI is described in artifact UNI-BT:UES.DOC/URI_V2/HLC.

Normalization of an UESURI requires that active territory is the same as territory specified within the normalized UESURI.

Parameters:

uri - UESURI to normalize.

forceRefresh - This parameter enforces usage of persistent storage. If this parameter is set to the value true, UESURI will contain actual codes for every UESURI part. This is useful e.g. if the UESURI will be displayed to user.
If the parameter is set to the false value, UESURI will be created using cache (application performance will be better) and some UESURI part can contain obsoleted code. This is suitable for the most other cases (e.g. when the UESURI will be used for navigation between artifacts - in such case only OID are used).

Returns:

Normalized UESURI or the null reference if the UESURI cannot be normalized (e.g. the UESURI is ambiguous; there is no persistent object referenced by the UESURI,...).

Throws:

InvalidUESURIFormatRTException - If UESURI cannot be normalized due to invalid format.

Since:

UES7-01

See Also:

UESTerritoryService

isNormalized

boolean isNormalized(UESURI uri)

Tests, whether is the UESURI in normalized form. Normalized form of an UESURI is specified in artifact UNI-BT:UES.DOC/URI_V2/HLC.

Parameters:

uri - Tested UESURI.

Returns:

True, when UESURI is normalized, otherwise false.

Since:

UES6-00

getCanonicalURI

UESURI getCanonicalURI(UESURI uri)
throws InvalidUESURIFormatRTException

Returns canonical UESURI. Canonical form of UESURI is described in artifact UNI-BT:UES.DOC/URI_V2/HLC.

Parameters:

uri - UESURI for canonicalization.

Returns:

Canonical UESURI or the null reference if the UESURI cannot be canonicalized (e.g. the UESURI is ambiguous; there is no persistent object referenced by the UESURI,...).

Throws:

InvalidUESURIFormatRTException - If UESURI cannot be canonicalized due to invalid format.

Since:

UES6-00

isCanonical

boolean isCanonical(UESURI uri)

Tests, whether is the UESURI in canonical form. Canonical form of an UESURI is specified in artifact UNI-BT:UES.DOC/URI_V2/HLC.

Parameters:

uri - Tested UESURI.

Returns:

True, when UESURI is in canonical form, otherwise false.

Since:

UES6-00

getEvaluatedURI

UESURI getEvaluatedURI(UESURI uri)

Returns evaluated UESURI. Evaluation of UESURI expressions is described in artifact UNI-BT:UES.DOC/URI_V2/HLC.

Parameters:

uri - UESURI for evaluation.

Returns:

Evaluated UESURI.

Since:

UES6-06

isEvaluated

boolean isEvaluated(UESURI uri)

Tests whether is the UESURI evaluated (expressions are resolved). Evaluation of UESURI expressions is described in artifact UNI-BT:UES.DOC/URI_V2/HLC.

Parameters:

uri - UESURI for evaluation.

Returns:

True when UESURI is evaluated, otherwise false.

Since:

UES6-06

getCodeBasedURI

UESURI getCodeBasedURI(UESURI uri)

Returns UESURI containing only codes. All IDs are removed, codes are added, role is removed and expressions evaluated.

Parameters:

uri - UESURI.

Returns:

Code-based UESURI.

Since:

UES7-10

isCodeBased

boolean isCodeBased(UESURI uri)

Tests whether the UESURI contains only codes, see details about code-based UESURI in UESURIConvertor.getCodeBasedURI(UESURI).

Parameters:

uri - UESURI.

Returns:

true if UESURI contains only codes.

Since:

UES7-10

convertToCoreURI

UESURI convertToCoreURI(UESURI uri)

Converts platform UESURI to core UESURI.

Parameters:

uri - UESURI for conversion

Returns:

Core UESURI.

Since:

UES7-10