org.sdmxsource.sdmx.sdmxbeans.model.header

Class HeaderBeanImpl

java.lang.Object

org.sdmxsource.sdmx.sdmxbeans.model.header.HeaderBeanImpl

All Implemented Interfaces:

java.io.Serializable, HeaderBean

public class HeaderBeanImpl
extends java.lang.Object
implements HeaderBean, java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.sdmxsource.sdmx.api.model.header.HeaderBean

DATASET_AGENCY, DSD_AGENCY_REF, DSD_REF

Constructor Summary

Constructors

Constructor and Description
HeaderBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.message.BaseHeaderType headerType)
HeaderBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.message.HeaderType headerType)
HeaderBeanImpl(org.sdmx.resources.sdmxml.schemas.v10.xmlbeans.message.HeaderType headerType)
HeaderBeanImpl(java.util.Map<java.lang.String,java.lang.String> additionalAttributes, java.util.List<DatasetStructureReferenceBean> structures, StructureReferenceBean dataProviderReference, DATASET_ACTION datasetAction, java.lang.String id, java.lang.String datasetId, java.util.Date embargoDate, java.util.Date extracted, java.util.Date prepared, java.util.Date reportingBegin, java.util.Date reportingEnd, java.util.List<TextTypeWrapper> name, java.util.List<TextTypeWrapper> source, java.util.List<PartyBean> receiver, PartyBean sender, boolean test)
HeaderBeanImpl(java.lang.String id, java.util.Date prepared, java.util.Date reportingBegin, java.util.Date reportingEnd, java.util.List<PartyBean> receiver, PartyBean sender, boolean isTest) Minimal Constructor
HeaderBeanImpl(java.lang.String id, java.lang.String senderId)

Method Summary

Methods

Modifier and Type	Method and Description
void	addName(TextTypeWrapper name) Adds a name to the list
void	addReceiver(PartyBean recevier) Adds a receiver to the list of receivers
void	addSource(TextTypeWrapper source) Adds a source to the list of sources
void	addStructure(DatasetStructureReferenceBean ref) Adds a dataset structure reference to the list
DATASET_ACTION	getAction() Gets the action for the message
java.lang.String	getAdditionalAttribute(java.lang.String headerField) Returns the header value for a given field.
java.util.Map<java.lang.String,java.lang.String>	getAdditionalAttributes() Returns a map of any additional attributes that are stored in the header - the key is the field, such as Header.DSD_REF, the value is the value of that field
StructureReferenceBean	getDataProviderReference() Returns the data provider reference
java.lang.String	getDatasetId() Gets a dataset id for the message
java.util.Date	getEmbargoDate() Returns the embargo date for the message
java.util.Date	getExtracted() Returns the extracted date for the message
java.lang.String	getId() Gets the id of the header
java.util.List<TextTypeWrapper>	getName() Returns the name, or an empty list if none are defined
java.util.Date	getPrepared() Returns the prepared date for the message
java.util.List<PartyBean>	getReceiver() Returns the list of receivers or an empty list if none are defined
java.util.Date	getReportingBegin() Returns the reporting begin date
java.util.Date	getReportingEnd() Returns the reporting end date
PartyBean	getSender() Returns the sender
java.util.List<TextTypeWrapper>	getSource() Returns the list of sources, or an empty list if none are defined
DatasetStructureReferenceBean	getStructureById(java.lang.String structureId) Returns the structure for the given id
java.util.List<DatasetStructureReferenceBean>	getStructures() Returns all data structure references
boolean	hasAdditionalAttribute(java.lang.String headerField) Returns true if this Header instance has a value stored for this property in its additional attributes @See getAdditionalAttributes()
boolean	isTest() Returns true if this is a test message
void	setAction(DATASET_ACTION action) Sets the action for the message
void	setDataProviderReference(StructureReferenceBean dataProvider) Sets the data provider reference
void	setDatasetId(java.lang.String datasetId) Sets a dataset id for the message
void	setEmbargoDate(java.util.Date aDate) Sets the embargo date for the message
void	setId(java.lang.String id) Sets the id of the message, can not be null
void	setReportingBegin(java.util.Date date) Sets the reporting being date
void	setReportingEnd(java.util.Date date) Sets the reporting end date
void	setSender(PartyBean party) Sets the sender (can not be null)
void	setTest(boolean test) True if this is a test message

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderBeanImpl

public HeaderBeanImpl(java.lang.String id,
              java.lang.String senderId)

HeaderBeanImpl

public HeaderBeanImpl(java.lang.String id,
              java.util.Date prepared,
              java.util.Date reportingBegin,
              java.util.Date reportingEnd,
              java.util.List<PartyBean> receiver,
              PartyBean sender,
              boolean isTest)

Minimal Constructor

Parameters:

id -

datasetId -

prepared -

receiver -

sender -

HeaderBeanImpl

public HeaderBeanImpl(java.util.Map<java.lang.String,java.lang.String> additionalAttributes,
              java.util.List<DatasetStructureReferenceBean> structures,
              StructureReferenceBean dataProviderReference,
              DATASET_ACTION datasetAction,
              java.lang.String id,
              java.lang.String datasetId,
              java.util.Date embargoDate,
              java.util.Date extracted,
              java.util.Date prepared,
              java.util.Date reportingBegin,
              java.util.Date reportingEnd,
              java.util.List<TextTypeWrapper> name,
              java.util.List<TextTypeWrapper> source,
              java.util.List<PartyBean> receiver,
              PartyBean sender,
              boolean test)

HeaderBeanImpl

public HeaderBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.message.BaseHeaderType headerType)

HeaderBeanImpl

public HeaderBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.message.HeaderType headerType)

HeaderBeanImpl

public HeaderBeanImpl(org.sdmx.resources.sdmxml.schemas.v10.xmlbeans.message.HeaderType headerType)

Method Detail

getDataProviderReference

public StructureReferenceBean getDataProviderReference()

Description copied from interface: HeaderBean

Returns the data provider reference

Specified by:

getDataProviderReference in interface HeaderBean

Returns:

getStructureById

public DatasetStructureReferenceBean getStructureById(java.lang.String structureId)

Description copied from interface: HeaderBean

Returns the structure for the given id

Specified by:

getStructureById in interface HeaderBean

Returns:

setId

public void setId(java.lang.String id)

Description copied from interface: HeaderBean

Sets the id of the message, can not be null

Specified by:

setId in interface HeaderBean

setSender

public void setSender(PartyBean party)

Description copied from interface: HeaderBean

Sets the sender (can not be null)

Specified by:

setSender in interface HeaderBean

setTest

public void setTest(boolean test)

Description copied from interface: HeaderBean

True if this is a test message

Specified by:

setTest in interface HeaderBean

addStructure

public void addStructure(DatasetStructureReferenceBean ref)

Description copied from interface: HeaderBean

Adds a dataset structure reference to the list

Specified by:

addStructure in interface HeaderBean

getStructures

public java.util.List<DatasetStructureReferenceBean> getStructures()

Description copied from interface: HeaderBean

Returns all data structure references

Specified by:

getStructures in interface HeaderBean

Returns:

getAction

public DATASET_ACTION getAction()

Description copied from interface: HeaderBean

Gets the action for the message

Specified by:

getAction in interface HeaderBean

Returns:

getId

public java.lang.String getId()

Description copied from interface: HeaderBean

Gets the id of the header

Specified by:

getId in interface HeaderBean

Returns:

getDatasetId

public java.lang.String getDatasetId()

Description copied from interface: HeaderBean

Gets a dataset id for the message

Specified by:

getDatasetId in interface HeaderBean

Returns:

getEmbargoDate

public java.util.Date getEmbargoDate()

Description copied from interface: HeaderBean

Returns the embargo date for the message

Specified by:

getEmbargoDate in interface HeaderBean

Returns:

embargo of null if undefined

setEmbargoDate

public void setEmbargoDate(java.util.Date aDate)

Description copied from interface: HeaderBean

Sets the embargo date for the message

Specified by:

setEmbargoDate in interface HeaderBean

getExtracted

public java.util.Date getExtracted()

Description copied from interface: HeaderBean

Returns the extracted date for the message

Specified by:

getExtracted in interface HeaderBean

Returns:

extracted or null if undefined

getName

public java.util.List<TextTypeWrapper> getName()

Description copied from interface: HeaderBean

Returns the name, or an empty list if none are defined

Specified by:

getName in interface HeaderBean

Returns:

getPrepared

public java.util.Date getPrepared()

Description copied from interface: HeaderBean

Returns the prepared date for the message

Specified by:

getPrepared in interface HeaderBean

Returns:

prepared or null if undefined

getReceiver

public java.util.List<PartyBean> getReceiver()

Description copied from interface: HeaderBean

Returns the list of receivers or an empty list if none are defined

Specified by:

getReceiver in interface HeaderBean

Returns:

getReportingBegin

public java.util.Date getReportingBegin()

Description copied from interface: HeaderBean

Returns the reporting begin date

Specified by:

getReportingBegin in interface HeaderBean

Returns:

setReportingBegin

public void setReportingBegin(java.util.Date date)

Description copied from interface: HeaderBean

Sets the reporting being date

Specified by:

setReportingBegin in interface HeaderBean

getReportingEnd

public java.util.Date getReportingEnd()

Description copied from interface: HeaderBean

Returns the reporting end date

Specified by:

getReportingEnd in interface HeaderBean

Returns:

setReportingEnd

public void setReportingEnd(java.util.Date date)

Description copied from interface: HeaderBean

Sets the reporting end date

Specified by:

setReportingEnd in interface HeaderBean

getSource

public java.util.List<TextTypeWrapper> getSource()

Description copied from interface: HeaderBean

Returns the list of sources, or an empty list if none are defined

Specified by:

getSource in interface HeaderBean

Returns:

getSender

public PartyBean getSender()

Description copied from interface: HeaderBean

Returns the sender

Specified by:

getSender in interface HeaderBean

Returns:

isTest

public boolean isTest()

Description copied from interface: HeaderBean

Returns true if this is a test message

Specified by:

isTest in interface HeaderBean

Returns:

getAdditionalAttributes

public java.util.Map<java.lang.String,java.lang.String> getAdditionalAttributes()

Description copied from interface: HeaderBean

Returns a map of any additional attributes that are stored in the header - the key is the field, such as Header.DSD_REF, the value is the value of that field

Specified by:

getAdditionalAttributes in interface HeaderBean

Returns:

hasAdditionalAttribute

public boolean hasAdditionalAttribute(java.lang.String headerField)

Description copied from interface: HeaderBean

Returns true if this Header instance has a value stored for this property in its additional attributes @See getAdditionalAttributes()

Specified by:

hasAdditionalAttribute in interface HeaderBean

Returns:

getAdditionalAttribute

public java.lang.String getAdditionalAttribute(java.lang.String headerField)

Description copied from interface: HeaderBean

Returns the header value for a given field. For example getHeaderValue(Header.DSD_REF) would return the value given for the keyFamilyRef (SDMX 2.0)

Specified by:

getAdditionalAttribute in interface HeaderBean

Returns:

setDataProviderReference

public void setDataProviderReference(StructureReferenceBean dataProvider)

Description copied from interface: HeaderBean

Sets the data provider reference

Specified by:

setDataProviderReference in interface HeaderBean

setAction

public void setAction(DATASET_ACTION action)

Description copied from interface: HeaderBean

Sets the action for the message

Specified by:

setAction in interface HeaderBean

setDatasetId

public void setDatasetId(java.lang.String datasetId)

Description copied from interface: HeaderBean

Sets a dataset id for the message

Specified by:

setDatasetId in interface HeaderBean

addName

public void addName(TextTypeWrapper name)

Description copied from interface: HeaderBean

Adds a name to the list

Specified by:

addName in interface HeaderBean

addReceiver

public void addReceiver(PartyBean recevier)

Description copied from interface: HeaderBean

Adds a receiver to the list of receivers

Specified by:

addReceiver in interface HeaderBean

addSource

public void addSource(TextTypeWrapper source)

Description copied from interface: HeaderBean

Adds a source to the list of sources

Specified by:

addSource in interface HeaderBean