org.sdmxsource.sdmx.api.model.beans.conceptscheme

Interface ConceptSchemeBean

All Superinterfaces:

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

All Known Implementing Classes:

ConceptSchemeBeanImpl

public interface ConceptSchemeBean
extends ItemSchemeBean<ConceptBean>

Represents an SDMX Concept Scheme

Author:

Matt Nelson

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SCHEME_ID
static java.lang.String	DEFAULT_SCHEME_NAME
static java.lang.String	DEFAULT_SCHEME_VERSION

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

DEFAULT_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
ConceptBean	getItemById(java.lang.String id) Returns the conncept by id, or null if there is no concept with the given id
ConceptSchemeMutableBean	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.
ConceptSchemeBean	getStub(java.net.URL actualLocation, boolean isServiceUrl) Returns a stub reference of itself.
boolean	isDefaultScheme() Returns true if this is the default concept scheme

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

filterItems, getItems, isPartial

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

Field Detail

DEFAULT_SCHEME_ID

static final java.lang.String DEFAULT_SCHEME_ID

See Also:

Constant Field Values

DEFAULT_SCHEME_NAME

static final java.lang.String DEFAULT_SCHEME_NAME

See Also:

Constant Field Values

DEFAULT_SCHEME_VERSION

static final java.lang.String DEFAULT_SCHEME_VERSION

See Also:

Constant Field Values

Method Detail

getStub

ConceptSchemeBean 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:

getItemById

ConceptBean getItemById(java.lang.String id)

Returns the conncept by id, or null if there is no concept with the given id

Parameters:

id -

Returns:

getMutableInstance

ConceptSchemeMutableBean 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:

isDefaultScheme

boolean isDefaultScheme()

Returns true if this is the default concept scheme

Returns: