Class: SdmxUrn

structure. SdmxUrn

Parses a URN into it's parts


new SdmxUrn()

Example
urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=ACY:DF_MYFLOW(1.0)
=agency id:ACY
=id:DF_MYFLOW
=version:1.0

urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=ESTAT:ESTAT_DATAFLOWS_SCHEME(1.0).Census.1.11
=agency id:ESTAT
=id:ESTAT_DATAFLOWS_SCHEME
=version:1.0
=identifiable id=Census.1.11

Methods


createStructureQuery( [detail] [, references])

Creates a {bean.StructureQuery|Structure Query} from this URN

Parameters:
Name Type Argument Default Description
detail string <optional>
full

Possible values are: "allstubs" (all artefacts should be returned as stubs), "referencestubs" (referenced artefacts should be returned as stubs) and "full" (all available information for all artefacts should be returned)

references string <optional>
none

Possible values are: "none" (no references will be returned), "parents" (the artefacts that use the artefact matching the query), "parentsandsiblings" (the artefacts that use the artefact matching the query, as well as the artefacts referenced by these artefacts), "children" (artefacts referenced by the artefact to be returned), "descendants" (references of references, up to any level, will also be returned), "all" (the combination of parentsandsiblings and descendants)

Returns:
Type
bean.StructureQuery

getAgencyId()

Returns the Agency Id of the Structure (this is contained in the URN)

Returns:
Type
string

getId()

Returns the Maintainable Id of the structure (this is contained in the URN)

Returns:
Type
string

getIdentifiableId()

Returns the Identifiable Id of the structure, or null if there is none (this is contained in the URN)

Returns:
Type
string

getShortUrn()

Returns the shorteded URN as a String.

A shortened URN is everything that appears after the "="

Returns:
Type
string

getStructureType( [getClass])

Returns the structure type of the structure (this is contained in the URN)

Parameters:
Name Type Argument Description
getClass boolean <optional>

if true, this will return the JavaScript class instead

Returns:
Type
string

getUrn()

Returns the full URN as a String. The URN is generated on the server based on the properties of the structure. The URN does not change over time, so it can be used to uniquely identify a structure in a consistent way

Returns:
Type
string

getVersion()

Returns the Maintainable version of the structure (this is contained in the URN)

Returns:
Type
string