org.sdmxsource.sdmx.api.model.beans.mapping

Interface StructureSetBean

All Superinterfaces:

AnnotableBean, java.lang.Comparable<MaintainableBean>, IdentifiableBean, MaintainableBean, NameableBean, SDMXBean, SdmxStructureBean, java.io.Serializable

All Known Implementing Classes:

StructureSetBeanImpl

public interface StructureSetBean
extends MaintainableBean

Represents an SDMX Structure Set

Author:

Matt Nelson

Field Summary

Fields inherited from interface org.sdmxsource.sdmx.api.model.beans.base.MaintainableBean

DEFAULT_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<CategorySchemeMapBean>	getCategorySchemeMapList()
java.util.List<CodelistMapBean>	getCodelistMapList() CodelistMap links a source and target codes from different lists where there is a semantic equivalence between them.
java.util.List<ConceptSchemeMapBean>	getConceptSchemeMapList() ConceptSchemeMap links a source and target concepts from different schemes where there is a semantic equivalence between them.
StructureSetMutableBean	getMutableInstance() Returns a representation of itself in a bean which can be modified, modifications to the mutable bean are not reflected in the instance of the MaintainableBean.
java.util.List<OrganisationSchemeMapBean>	getOrganisationSchemeMapList()
RelatedStructuresBean	getRelatedStructures() RelatedStructures contains references to structures (key families and metadata structure definitions) and structure usages (data flows and metadata flows) to indicate that a semantic relationship exist between them.
java.util.List<StructureMapBean>	getStructureMapList() StructureMap maps components from one structure to components to another structure, and can describe how the value of the components are related.
StructureSetBean	getStub(java.net.URL actualLocation, boolean isServiceUrl) Returns a stub reference of itself.

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.MaintainableBean

addAnnotations, getAgencyId, getEndDate, getServiceURL, getStartDate, getStructureURL, getVersion, isExternalReference, isFinal

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.NameableBean

getDescription, getDescriptions, getName, getNames

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.IdentifiableBean

asReference, getAllTextTypes, getFullIdPath, getId, getUri, getUrn

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.AnnotableBean

getAnnotations, getAnnotationsByTitle, getAnnotationsByType, hasAnnotationType

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.SdmxStructureBean

getIdentifiableComposites, getIdentifiableParent, getMaintainableParent, getParent

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.SDMXBean

deepEquals, getComposites, getComposites, getCrossReferences, getParent, getStructureType

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getRelatedStructures

RelatedStructuresBean getRelatedStructures()

RelatedStructures contains references to structures (key families and metadata structure definitions) and structure usages (data flows and metadata flows) to indicate that a semantic relationship exist between them. The details of these relationships can be found in the structure maps.

Returns:

getStructureMapList

java.util.List<StructureMapBean> getStructureMapList()

StructureMap maps components from one structure to components to another structure, and can describe how the value of the components are related.

Returns:

getCodelistMapList

java.util.List<CodelistMapBean> getCodelistMapList()

CodelistMap links a source and target codes from different lists where there is a semantic equivalence between them.

Returns:

getCategorySchemeMapList

java.util.List<CategorySchemeMapBean> getCategorySchemeMapList()

getConceptSchemeMapList

java.util.List<ConceptSchemeMapBean> getConceptSchemeMapList()

ConceptSchemeMap links a source and target concepts from different schemes where there is a semantic equivalence between them.

Returns:

getOrganisationSchemeMapList

java.util.List<OrganisationSchemeMapBean> getOrganisationSchemeMapList()

getStub

StructureSetBean getStub(java.net.URL actualLocation,
                       boolean isServiceUrl)

Returns a stub reference of itself.

A stub bean only contains Maintainable and Identifiable Attributes, not the composite Objects that are contained within the Maintainable

Specified by:

getStub in interface MaintainableBean

Parameters:

actualLocation - the URL indicating where the full structure can be returned from

isServiceUrl - if true this URL will be present on the serviceURL attribute, otherwise it will be treated as a structureURL attribute

Returns:

getMutableInstance

StructureSetMutableBean getMutableInstance()

Returns a representation of itself in a bean which can be modified, modifications to the mutable bean are not reflected in the instance of the MaintainableBean.

Specified by:

getMutableInstance in interface MaintainableBean

Returns: