org.sdmxsource.sdmx.sdmxbeans.model.header

Class DatasetHeaderBeanImpl

java.lang.Object

org.sdmxsource.sdmx.sdmxbeans.model.header.DatasetHeaderBeanImpl

All Implemented Interfaces:

DatasetHeaderBean

public class DatasetHeaderBeanImpl
extends java.lang.Object
implements DatasetHeaderBean

Constructor Summary

Constructors

Constructor and Description
DatasetHeaderBeanImpl(java.lang.String datasetId, DATASET_ACTION action, DatasetStructureReferenceBean datasetStructureReferenceBean) Minimal Constructor
DatasetHeaderBeanImpl(java.lang.String datasetId, DATASET_ACTION action, DatasetStructureReferenceBean datasetStructureReferenceBean, MaintainableRefBean dataProviderRef, java.util.Date reportingBeginDate, java.util.Date reportingEndDate, java.util.Date validFrom, java.util.Date validTo, int publicationYear, java.lang.String publicationPeriod, java.lang.String reportingYearStartDate)
DatasetHeaderBeanImpl(javax.xml.stream.XMLStreamReader parser, HeaderBean datasetHeader) Create an instance from a parser reading the dataset XML Node and the header

Method Summary

Methods

Modifier and Type	Method and Description
DATASET_ACTION	getAction() Returns the action for this dataset, defaults to INFORMATION
MaintainableRefBean	getDataProviderReference() Returns a reference to the data provider for this data.
java.lang.String	getDatasetId() Returns an id for the dataset
DatasetStructureReferenceBean	getDataStructureReference() Returns a DatasetStructureReferenceBean containing information about what structure is used to descirbe the structure of this dataset
java.lang.String	getPublicationPeriod() Returns the reporting end date for this dataset
int	getPublicationYear() Returns the reporting end date for this dataset
java.util.Date	getReportingBeginDate() Returns the reporting begin date for this dataset
java.util.Date	getReportingEndDate() Returns the reporting end date for this dataset
java.util.Date	getValidFrom() Returns the reporting end date for this dataset
java.util.Date	getValidTo() Returns the reporting end date for this dataset
boolean	isTimeSeries() Returns true if the DataReaderEngine is reading time series data (observations iterate over time).
DatasetHeaderBean	modifyDataStructureReference(DatasetStructureReferenceBean datasetStructureReferenceBean) Creates a new DatasetHeaderBean, copying over all the attributes of this header, but replacing the DatasetStructureReferenceBean with the one passed in
void	setAction(DATASET_ACTION action)
void	setDataProviderRef(MaintainableRefBean dataProviderRef)
void	setDatasetId(java.lang.String datasetId)
void	setDatasetStructureReferenceBean(DatasetStructureReferenceBean datasetStructureReferenceBean)
void	setPublicationPeriod(java.lang.String publicationPeriod)
void	setPublicationYear(int publicationYear)
void	setReportingBeginDate(java.util.Date reportingBeginDate)
void	setReportingEndDate(java.util.Date reportingEndDate)
void	setReportingYearStartDate(java.lang.String reportingYearStartDate)
void	setValidFrom(java.util.Date validFrom)
void	setValidTo(java.util.Date validTo)

Methods inherited from class java.lang.Object

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

Constructor Detail

DatasetHeaderBeanImpl

public DatasetHeaderBeanImpl(java.lang.String datasetId,
                     DATASET_ACTION action,
                     DatasetStructureReferenceBean datasetStructureReferenceBean)

Minimal Constructor

Parameters:

datasetId -

action -

datasetStructureReferenceBean -

DatasetHeaderBeanImpl

public DatasetHeaderBeanImpl(java.lang.String datasetId,
                     DATASET_ACTION action,
                     DatasetStructureReferenceBean datasetStructureReferenceBean,
                     MaintainableRefBean dataProviderRef,
                     java.util.Date reportingBeginDate,
                     java.util.Date reportingEndDate,
                     java.util.Date validFrom,
                     java.util.Date validTo,
                     int publicationYear,
                     java.lang.String publicationPeriod,
                     java.lang.String reportingYearStartDate)

DatasetHeaderBeanImpl

public DatasetHeaderBeanImpl(javax.xml.stream.XMLStreamReader parser,
                     HeaderBean datasetHeader)

Create an instance from a parser reading the dataset XML Node and the header

Parameters:

parser -

datasetHeader -

Method Detail

modifyDataStructureReference

public DatasetHeaderBean modifyDataStructureReference(DatasetStructureReferenceBean datasetStructureReferenceBean)

Description copied from interface: DatasetHeaderBean

Creates a new DatasetHeaderBean, copying over all the attributes of this header, but replacing the DatasetStructureReferenceBean with the one passed in

Specified by:

modifyDataStructureReference in interface DatasetHeaderBean

Returns:

isTimeSeries

public boolean isTimeSeries()

Description copied from interface: DatasetHeaderBean

Returns true if the DataReaderEngine is reading time series data (observations iterate over time). If false time will be at the series level

Specified by:

isTimeSeries in interface DatasetHeaderBean

Returns:

getDataStructureReference

public DatasetStructureReferenceBean getDataStructureReference()

Description copied from interface: DatasetHeaderBean

Returns a DatasetStructureReferenceBean containing information about what structure is used to descirbe the structure of this dataset

Specified by:

getDataStructureReference in interface DatasetHeaderBean

Returns:

returns null if there is no reference

getAction

public DATASET_ACTION getAction()

Description copied from interface: DatasetHeaderBean

Returns the action for this dataset, defaults to INFORMATION

Specified by:

getAction in interface DatasetHeaderBean

Returns:

getDataProviderReference

public MaintainableRefBean getDataProviderReference()

Description copied from interface: DatasetHeaderBean

Returns a reference to the data provider for this data.

Specified by:

getDataProviderReference in interface DatasetHeaderBean

Returns:

returns null if there is no reference

getDatasetId

public java.lang.String getDatasetId()

Description copied from interface: DatasetHeaderBean

Returns an id for the dataset

Specified by:

getDatasetId in interface DatasetHeaderBean

Returns:

returns null if no id was given

getReportingBeginDate

public java.util.Date getReportingBeginDate()

Description copied from interface: DatasetHeaderBean

Returns the reporting begin date for this dataset

Specified by:

getReportingBeginDate in interface DatasetHeaderBean

Returns:

returns null if there is no reporting begin date defined

getReportingEndDate

public java.util.Date getReportingEndDate()

Description copied from interface: DatasetHeaderBean

Returns the reporting end date for this dataset

Specified by:

getReportingEndDate in interface DatasetHeaderBean

Returns:

returns null if there is no reporting end date defined

getValidFrom

public java.util.Date getValidFrom()

Description copied from interface: DatasetHeaderBean

Returns the reporting end date for this dataset

Specified by:

getValidFrom in interface DatasetHeaderBean

Returns:

returns null if there is no valid from date defined

getValidTo

public java.util.Date getValidTo()

Description copied from interface: DatasetHeaderBean

Returns the reporting end date for this dataset

Specified by:

getValidTo in interface DatasetHeaderBean

Returns:

returns null if there is no valid to defined

getPublicationYear

public int getPublicationYear()

Description copied from interface: DatasetHeaderBean

Returns the reporting end date for this dataset

Specified by:

getPublicationYear in interface DatasetHeaderBean

Returns:

returns -1 if there is no publication year given defined

getPublicationPeriod

public java.lang.String getPublicationPeriod()

Description copied from interface: DatasetHeaderBean

Returns the reporting end date for this dataset

Specified by:

getPublicationPeriod in interface DatasetHeaderBean

Returns:

returns null if there is no publication period defined

setDataProviderRef

public void setDataProviderRef(MaintainableRefBean dataProviderRef)

setDatasetStructureReferenceBean

public void setDatasetStructureReferenceBean(DatasetStructureReferenceBean datasetStructureReferenceBean)

setDatasetId

public void setDatasetId(java.lang.String datasetId)

setReportingBeginDate

public void setReportingBeginDate(java.util.Date reportingBeginDate)

setReportingEndDate

public void setReportingEndDate(java.util.Date reportingEndDate)

setValidFrom

public void setValidFrom(java.util.Date validFrom)

setValidTo

public void setValidTo(java.util.Date validTo)

setAction

public void setAction(DATASET_ACTION action)

setPublicationYear

public void setPublicationYear(int publicationYear)

setPublicationPeriod

public void setPublicationPeriod(java.lang.String publicationPeriod)

setReportingYearStartDate

public void setReportingYearStartDate(java.lang.String reportingYearStartDate)