org.sdmxsource.sdmx.api.model.beans.base

Interface IdentifiableBean

All Superinterfaces:

AnnotableBean, SDMXBean, SdmxStructureBean, java.io.Serializable

All Known Subinterfaces:

AgencyBean, AgencySchemeBean, AttachmentConstraintBean, AttributeBean, AttributeListBean, CategorisationBean, CategoryBean, CategorySchemeBean, CategorySchemeMapBean, CodeBean, CodelistBean, CodelistMapBean, ComponentBean, ConceptBaseBean, ConceptBean, ConceptSchemeBean, ConceptSchemeMapBean, ConstrainableBean, ConstraintBean, ConstraintContentTargetBean, ContentConstraintBean, CrossSectionalDataStructureBean, CrossSectionalMeasureBean, DataConsumerBean, DataConsumerSchemeBean, DataflowBean, DataProviderBean, DataProviderSchemeBean, DataSetTargetBean, DataStructureBean, DimensionBean, DimensionListBean, GroupBean, HierarchicalCodeBean, HierarchicalCodelistBean, HierarchicalItemBean<T>, HierarchyBean, IdentifiableTargetBean, ItemBean, ItemSchemeBean<T>, ItemSchemeMapBean, KeyDescriptorValuesTargetBean, LevelBean, MaintainableBean, MeasureListBean, MetadataAttributeBean, MetadataFlowBean, MetadataStructureDefinitionBean, MetadataTargetBean, NameableBean, OrganisationBean, OrganisationSchemeBean<T>, OrganisationSchemeMapBean, OrganisationUnitBean, OrganisationUnitSchemeBean, PrimaryMeasureBean, ProcessBean, ProcessStepBean, ProvisionAgreementBean, RegistrationBean, ReportingCategoryBean, ReportingTaxonomyBean, ReportPeriodTargetBean, ReportStructureBean, SchemeMapBean, StructureMapBean, StructureSetBean, StructureUsage, SubscriptionBean, TransitionBean

All Known Implementing Classes:

AgencyBeanImpl, AgencySchemeBeanImpl, AttachmentConstraintBeanImpl, AttributeBeanImpl, AttributeListBeanImpl, CategorisationBeanImpl, CategoryBeanImpl, CategorySchemeBeanImpl, CategorySchemeMapBeanImpl, CodeBeanImpl, CodelistBeanImpl, CodelistMapBeanImpl, ComponentBeanImpl, ConceptBeanImpl, ConceptSchemeBeanImpl, ConceptSchemeMapBeanImpl, ConstraintBeanImpl, ConstraintContentTargetBeanImpl, ContentConstraintBeanImpl, CrossSectionalDataStructureBeanImpl, CrossSectionalMeasureBeanImpl, DataConsumerBeanImpl, DataConsumerSchemeBeanImpl, DataflowBeanImpl, DataProviderBeanImpl, DataProviderSchemeBeanImpl, DataSetTargetBeanImpl, DataStructureBeanImpl, DimensionBeanImpl, DimensionListBeanImpl, GroupBeanImpl, HierarchicalCodeBeanImpl, HierarchicalCodelistBeanImpl, HierarchyBeanImpl, IdentifiableBeanImpl, IdentifiableTargetBeanImpl, ItemBeanImpl, ItemSchemeBeanImpl, ItemSchemeMapBeanImpl, KeyDescriptorValuesTargetBeanImpl, LevelBeanImpl, MaintainableBeanImpl, MeasureListBeanImpl, MetadataAttributeBeanImpl, MetadataflowBeanImpl, MetadataStructureDefinitionBeanImpl, MetadataTargetBeanImpl, NameableBeanImpl, OrganisationBeanImpl, OrganisationSchemeBeanImpl, OrganisationSchemeMapBeanImpl, OrganisationUnitBeanImpl, OrganisationUnitSchemeBeanImpl, PrimaryMeasureBeanImpl, ProcessBeanImpl, ProcessStepBeanImpl, ProvisionAgreementBeanImpl, RegistrationBeanImpl, ReportingCategoryBeanImpl, ReportingTaxonomyBeanImpl, ReportPeriodTargetBeanImpl, ReportStructureBeanImpl, SchemeMapBeanImpl, StructureMapBeanImpl, StructureSetBeanImpl, SubscriptionBeanImpl, TransitionBeanImpl

public interface IdentifiableBean
extends AnnotableBean, SdmxStructureBean

An Identifiable Bean describes a Bean which contains a unique identifier (urn) and can therefore be identified uniquely.

Author:

Matt Nelson

Method Summary

Methods

Modifier and Type	Method and Description
StructureReferenceBean	asReference() Builds a StructureReferenceBean that is a representation of this IdentifiableBean as a reference.
java.util.List<TextTypeWrapper>	getAllTextTypes() Returns a list of all the underlying text types for this identifiable (does not recurse down to children).
java.lang.String	getFullIdPath(boolean includeDifferentTypes) Returns a period separated id of this identifiable, starting from the non-maintainable top-level ancestor to this identifiable.
java.lang.String	getId() Returns the id for this component, this is a mandatory field and will never be null.
java.net.URI	getUri() Returns the URI for this component, returns null if there is no URI.
java.lang.String	getUrn() Returns the URN for this component.

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

Method Detail

getId

java.lang.String getId()

Returns the id for this component, this is a mandatory field and will never be null.

Returns:

getFullIdPath

java.lang.String getFullIdPath(boolean includeDifferentTypes)

Returns a period separated id of this identifiable, starting from the non-maintainable top-level ancestor to this identifiable.

For example, if this is "Category A" as a child of "Category AA", then this method will return AA.A (note the category scheme id is not present in this identifier).

Returns null if this is a maintainable bean.

Parameters:

includeDifferentTypes - if true will recurse all the way back up the tree regardless of ancestor types, up to the maintainable level. If false, will stop at the first occurrence of an ancestor who's getStructureType() is not equal to this.getStructureType().

Returns:

getUrn

java.lang.String getUrn()

Returns the URN for this component. The URN is unique to this instance and is a computable generated value based on other attributes set within the component.

Returns:

getUri

java.net.URI getUri()

Returns the URI for this component, returns null if there is no URI.

URI describes where additional information can be found for this component. This is guaranteed to return a value if the structure is a MaintainableBean and isExternalReference is true.

Returns:

asReference

StructureReferenceBean asReference()

Builds a StructureReferenceBean that is a representation of this IdentifiableBean as a reference. The returned StructureReferenceBean can be used to uniquely identify this identifiable bean.

Returns:

getAllTextTypes

java.util.List<TextTypeWrapper> getAllTextTypes()

Returns a list of all the underlying text types for this identifiable (does not recurse down to children).

Returns an empty list if there are no text types for this identifiable.

Returns: