SDMXBean

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

AgencyBean, AgencySchemeBean, AnnotableBean, AnnotationBean, AttachmentConstraintAttachmentBean, AttachmentConstraintBean, AttributeBean, AttributeListBean, CategorisationBean, CategoryBean, CategoryMapBean, CategorySchemeBean, CategorySchemeMapBean, CodeBean, CodelistBean, CodelistMapBean, CodelistRefBean, ComponentBean, ComponentMapBean, ComputationBean, ConceptBaseBean, ConceptBean, ConceptSchemeBean, ConceptSchemeMapBean, ConstrainableBean, ConstrainedDataKeyBean, ConstraintAttachmentBean, ConstraintBean, ConstraintContentTargetBean, ConstraintDataKeySetBean, ContactBean, ContentConstraintBean, CrossSectionalDataStructureBean, CrossSectionalMeasureBean, CubeRegionBean, DataConsumerBean, DataConsumerSchemeBean, DataflowBean, DataKeyBean, DataProviderBean, DataProviderSchemeBean, DataSetReferenceBean, DataSetTargetBean, DataSourceBean, DataStructureBean, DimensionBean, DimensionListBean, GroupBean, HierarchicalCodeBean, HierarchicalCodelistBean, HierarchicalItemBean<T>, HierarchyBean, IdentifiableBean, IdentifiableTargetBean, InputOutputBean, ItemBean, ItemMapBean, ItemSchemeBean<T>, ItemSchemeMapBean, KeyDescriptorValuesTargetBean, KeyValues, LevelBean, MaintainableBean, MeasureListBean, MetadataAttributeBean, MetadataBean, MetadataFlowBean, MetadataReportBean, MetadataSetBean, MetadataStructureDefinitionBean, MetadataTargetBean, MetadataTargetKeyValuesBean, MetadataTargetRegionBean, NameableBean, OrganisationBean, OrganisationSchemeBean<T>, OrganisationSchemeMapBean, OrganisationUnitBean, OrganisationUnitSchemeBean, PrimaryMeasureBean, ProcessBean, ProcessStepBean, ProvisionAgreementBean, ReferencePeriodBean, ReferenceValueBean, RegistrationBean, RelatedStructuresBean, ReleaseCalendarBean, ReportedAttributeBean, ReportingCategoryBean, ReportingTaxonomyBean, ReportPeriodTargetBean, ReportStructureBean, RepresentationBean, RepresentationMapRefBean, SchemeMapBean, SdmxStructureBean, StructureMapBean, StructureSetBean, StructureUsage, SubscriptionBean, TargetBean, TextFormatBean, TextTypeWrapper, TimeRangeBean, TransitionBean

All Known Implementing Classes:

AgencyBeanImpl, AgencySchemeBeanImpl, AnnotableBeanImpl, AnnotationBeanImpl, AttachmentConstraintAttachmentBeanImpl, AttachmentConstraintBeanImpl, AttributeBeanImpl, AttributeListBeanImpl, CategorisationBeanImpl, CategoryBeanImpl, CategoryMapBeanImpl, CategorySchemeBeanImpl, CategorySchemeMapBeanImpl, CodeBeanImpl, CodelistBeanImpl, CodelistMapBeanImpl, CodelistRefBeanImpl, ComponentBeanImpl, ComponentMapBeanImpl, ComputationBeanImpl, ConceptBeanImpl, ConceptSchemeBeanImpl, ConceptSchemeMapBeanImpl, ConstrainedDataKeyBeanImpl, ConstraintAttachmentBeanImpl, ConstraintBeanImpl, ConstraintContentTargetBeanImpl, ConstraintDataKeySetBeanImpl, ContactBeanImpl, ContentConstraintBeanImpl, CrossSectionalDataStructureBeanImpl, CrossSectionalMeasureBeanImpl, CubeRegionBeanImpl, DataConsumerBeanImpl, DataConsumerSchemeBeanImpl, DataflowBeanImpl, DataKeyBeanImpl, DataProviderBeanImpl, DataProviderSchemeBeanImpl, DataSetReferenceBeanImpl, DataSetTargetBeanImpl, DataSourceBeanImpl, DataStructureBeanImpl, DimensionBeanImpl, DimensionListBeanImpl, GroupBeanImpl, HierarchicalCodeBeanImpl, HierarchicalCodelistBeanImpl, HierarchyBeanImpl, IdentifiableBeanImpl, IdentifiableTargetBeanImpl, InputOutputBeanImpl, ItemBeanImpl, ItemMapBeanImpl, ItemSchemeBeanImpl, ItemSchemeMapBeanImpl, KeyDescriptorValuesTargetBeanImpl, KeyValuesImpl, LevelBeanImpl, MaintainableBeanImpl, MeasureListBeanImpl, MetadataAttributeBeanImpl, MetadataBeanImpl, MetadataflowBeanImpl, MetadataReportBeanImpl, MetadataSetBeanImpl, MetadataStructureDefinitionBeanImpl, MetadataTargetBeanImpl, MetadataTargetKeyValuesBeanImpl, MetadataTargetRegionBeanImpl, NameableBeanImpl, OrganisationBeanImpl, OrganisationSchemeBeanImpl, OrganisationSchemeMapBeanImpl, OrganisationUnitBeanImpl, OrganisationUnitSchemeBeanImpl, PrimaryMeasureBeanImpl, ProcessBeanImpl, ProcessStepBeanImpl, ProvisionAgreementBeanImpl, ReferencePeriodBeanImpl, ReferenceValueBeanImpl, RegistrationBeanImpl, RelatedStructuresBeanImpl, ReleaseCalendarBeanImpl, ReportedAttributeBeanImpl, ReportingCategoryBeanImpl, ReportingTaxonomyBeanImpl, ReportPeriodTargetBeanImpl, ReportStructureBeanImpl, RepresentationBeanImpl, RepresentationMapRefBeanImpl, SchemeMapBeanImpl, SDMXBeanImpl, SdmxStructureBeanImpl, StructureMapBeanImpl, StructureSetBeanImpl, SubscriptionBeanImpl, TargetBeanImpl, TextFormatBeanImpl, TextTypeWrapperImpl, TimeRangeBeanImpl, TransitionBeanImpl
```
public interface SDMXBean
extends java.io.Serializable
```
An SDMXBean represents any SDMX structural artifact or metadata structure artifact.
All classes which inherit from SDMXBean are immutable, meaning they can not have any of their contents modified. Any collections returned as a result of a method call will be copies of collections ensuring the immutability of the SDMXBean is preserved. This 'copy paradigm' is also true of composite objects returned, which are mutable, for example any object of type 'java.util.Date' will be a copy of the underlying Date object contained in the SDXMBean.

Author:

Matt Nelson

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`deepEquals(SDMXBean bean, boolean includeFinalProperties)` Returns true if this SdmxBean equals the given bean in every respect (except for the validTo property of a maintainable artefact, this is not taken into consideration) This method calls deepEquals on any SdmxBean composites.
`java.util.Set<SDMXBean>`	`getComposites()` Returns a set of composite beans to this bean
`<T> java.util.Set<T>`	`getComposites(java.lang.Class<T> type)` Returns any composites of this SdmxBean of the given type
`java.util.Set<CrossReferenceBean>`	`getCrossReferences()` Returns a set of cross references that are made by this bean, or by any composite bean of this bean
`SDMXBean`	`getParent()` Returns the parent that this SDMXBean belongs to If this is a MaintainableBean, then there will be no parent to return, so will return a value of null
`<T> T`	`getParent(java.lang.Class<T> type, boolean includeThisInSearch)` Recurses up the parent hierarchy to return the first occurrence of parent of the given type that this SDMXBean belongs to If a parent of the given type does not exist in the hierarchy, null will be returned
`SDMX_STRUCTURE_TYPE`	`getStructureType()` Returns the structure type of this component.

- Method Detail
  - getStructureType
```
SDMX_STRUCTURE_TYPE getStructureType()
```
    Returns the structure type of this component.
    
    Returns:
  - getParent
```
SDMXBean getParent()
```
    Returns the parent that this SDMXBean belongs to
    If this is a MaintainableBean, then there will be no parent to return, so will return a value of null
    
    Returns:
  - getParent
```
<T> T getParent(java.lang.Class<T> type,
              boolean includeThisInSearch)
```
    Recurses up the parent hierarchy to return the first occurrence of parent of the given type that this SDMXBean belongs to
    If a parent of the given type does not exist in the hierarchy, null will be returned
    
    Parameters:
    includeThisInSearch - if true then this type will be first checked to see if it is of the given type
    
    Returns:
  - getComposites
```
java.util.Set<SDMXBean> getComposites()
```
    Returns a set of composite beans to this bean
    
    Returns:
  - getComposites
```
<T> java.util.Set<T> getComposites(java.lang.Class<T> type)
```
    Returns any composites of this SdmxBean of the given type
    
    Type Parameters:
    T -
    Parameters:
    type -
    
    Returns:
  - getCrossReferences
```
java.util.Set<CrossReferenceBean> getCrossReferences()
```
    Returns a set of cross references that are made by this bean, or by any composite bean of this bean
    
    Returns:
  - deepEquals
```
boolean deepEquals(SDMXBean bean,
                 boolean includeFinalProperties)
```
    Returns true if this SdmxBean equals the given bean in every respect (except for the validTo property of a maintainable artefact, this is not taken into consideration)
    This method calls deepEquals on any SdmxBean composites.
    Parameters:
    bean - if null, then false will be returned
    includeFinalProperties - - if true, then this method will check every single property from this bean is equal to the passed in bean. If false, then this method will ignore the following properties:
    
    Name
    
    Description
    
    Annotation
    
    Valid From (Start Date)
    
    Valid To (End Date)
    
    Structure URL
    
    Service URL
    
    URI
    
    Is External Reference
    Returns:

Interface SDMXBean

Method Summary

Method Detail

getStructureType

getParent

getParent

getComposites

getComposites

getCrossReferences

deepEquals