org.sdmxsource.sdmx.api.model

Class ResolutionSettings

java.lang.Object

org.sdmxsource.sdmx.api.model.ResolutionSettings

All Implemented Interfaces:

java.lang.Cloneable

public class ResolutionSettings
extends java.lang.Object
implements java.lang.Cloneable

Contains all the settings for parsing structures.

The setting are given by enumerated flags at construction, making instances immutable.

Functions are available to reinterpret these settings when applied to parsing XML structures into beans.

The StructureSettings take into account two settings for parsing SDMX-ML documents

1. Resolve Cross References
2. Resolve External References

Cross References are declared by structures such as Key Families also known as a Data Structure Definition (DSD) (see DataStructureBean). A DSD contains a number of Dimensions (DimensionBean) a Dimension may declare a reference to a Codelist and a Concept through reference parameters.

If a system is to resolve the cross references, then it can do this by either of the following ways:

• Resolve the external reference exists at the given URI
• Resolve the external reference exists, and substitute it for the provided 'stub' artifact
• Either of the above two can be lenient (do not error if it can not be done) or not (throw exception if this could not be done)

External References are declared by MaintainableBean structures by having their isExternal attribute set to true. In this instance the Maintainable artifact is declaring that it is not the full artifact, but just an empty container whose purpose is to declare the existence of the artifact (stub). The stub also has the responsibility of declaring where to get the full artifact, this is defined by the URI attribute.

The StructureSettings provides the following options for resolving cross references:

• Do not resolve
• Resolve all the references (it is up to the implementation to decide how deep to resolve)
• Resolve all the references except for Agencies

External references are when a structure is declared, like a codelist, as a 'stub' containing the minimum possible information for it to be valid against the schema; i.e it has a name, id and agency id, but it also has a URI which says: if you want the full codelists, with a 100 million codes, it's retrievable from this location. This is useful if someone wants to store information in the registry, but maintain the contents of the artifacts externally.

See Also:

which is built from an XML message., which is built from resolving all the cross referenced artifacts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResolutionSettings.RESOLVE_CROSS_REFERENCES Flag options for handling Cross References
static class	ResolutionSettings.RESOLVE_EXTERNAL_SETTING Flag options for handling External References (structures not present but specified with a URI, indicating a remote file containing the missing structures).

Constructor Summary

Constructors

Constructor and Description
ResolutionSettings(ResolutionSettings.RESOLVE_EXTERNAL_SETTING resolveExternal, ResolutionSettings.RESOLVE_CROSS_REFERENCES resolveCrossRef) Constructor, all settings provided here, immutable hereafter.
ResolutionSettings(ResolutionSettings.RESOLVE_EXTERNAL_SETTING resolveExternal, ResolutionSettings.RESOLVE_CROSS_REFERENCES resolveCrossRef, int resolutionDepth) Constructor, all settings provided here, immutable hereafter.

Method Summary

Methods

Modifier and Type	Method and Description
ResolutionSettings	clone()
int	getResolutionDepth()
ResolutionSettings.RESOLVE_CROSS_REFERENCES	getResolveCrossRef()
ResolutionSettings.RESOLVE_EXTERNAL_SETTING	getResolveExternal()
boolean	isLenient() Returns true if the cross referenced structures need to be resolved to exist
boolean	isResolveAgencyReferences() Returns true if the cross referenced structures need to be resolved to exist
boolean	isResolveCrossReferences() Returns true if the cross referenced structures need to be resolved to exist
boolean	isResolveExternalReferences() Returns true if external references are to be retrieved and replace the stub
boolean	isSubstituteExternal() Returns true if the resolved external references should be substituted for the maintainable stub
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ResolutionSettings

public ResolutionSettings(ResolutionSettings.RESOLVE_EXTERNAL_SETTING resolveExternal,
                  ResolutionSettings.RESOLVE_CROSS_REFERENCES resolveCrossRef,
                  int resolutionDepth)

Constructor, all settings provided here, immutable hereafter.

Parameters:

resolveExternal -

resolveCrossRef -

resolutionDepth - - required if resolving references. 0 indicates resolve all, any other positive integer is the level of recursion to resolve

ResolutionSettings

public ResolutionSettings(ResolutionSettings.RESOLVE_EXTERNAL_SETTING resolveExternal,
                  ResolutionSettings.RESOLVE_CROSS_REFERENCES resolveCrossRef)

Constructor, all settings provided here, immutable hereafter.

Parameters:

resolveExternal -

resolveCrossRef -

Method Detail

getResolutionDepth

public int getResolutionDepth()

getResolveExternal

public ResolutionSettings.RESOLVE_EXTERNAL_SETTING getResolveExternal()

getResolveCrossRef

public ResolutionSettings.RESOLVE_CROSS_REFERENCES getResolveCrossRef()

isResolveExternalReferences

public boolean isResolveExternalReferences()

Returns true if external references are to be retrieved and replace the stub

Returns:

isResolveCrossReferences

public boolean isResolveCrossReferences()

Returns true if the cross referenced structures need to be resolved to exist

Returns:

isResolveAgencyReferences

public boolean isResolveAgencyReferences()

Returns true if the cross referenced structures need to be resolved to exist

Returns:

isSubstituteExternal

public boolean isSubstituteExternal()

Returns true if the resolved external references should be substituted for the maintainable stub

Returns:

isLenient

public boolean isLenient()

Returns true if the cross referenced structures need to be resolved to exist

Returns:

clone

public ResolutionSettings clone()

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object