org.xmcda.parsers.xml.xmcda_v3

Class MatrixParser<DIMENSION,VALUE_TYPE>

java.lang.Object

org.xmcda.parsers.xml.xmcda_v3.MatrixParser<DIMENSION,VALUE_TYPE>

Direct Known Subclasses:

AlternativesMatrixParser, AlternativesSetsMatrixParser, CategoriesMatrixParser, CategoriesSetsMatrixParser, CriteriaMatrixParser, CriteriaSetsMatrixParser

public abstract class MatrixParser<DIMENSION,VALUE_TYPE>
extends Object

Author:

Sébastien Bigaret

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLUMN
static String	ROW
static String	VALUATION

Constructor Summary

Constructors

Constructor and Description
MatrixParser()

Method Summary

Modifier and Type	Method and Description
abstract DIMENSION	buildDimension(XMCDA xmcda, String id)
protected LinkedHashSet<DIMENSION>	columnsForRow(Matrix<DIMENSION,VALUE_TYPE> matrix, DIMENSION row) Returns the columns having values in the matrix for the supplied row.
abstract String	dimensionID(DIMENSION obj)
abstract String	dimensionTag()
Matrix<DIMENSION,VALUE_TYPE>	fromXML(XMCDA xmcda, StartElement startElement, XMLEventReader eventReader)
void	readColumnsFromXML(XMCDA xmcda, Matrix<DIMENSION,VALUE_TYPE> matrix, DIMENSION row, StartElement startElement, XMLEventReader eventReader)
void	readRowsFromXML(XMCDA xmcda, Matrix<DIMENSION,VALUE_TYPE> matrix, StartElement startElement, XMLEventReader eventReader)
abstract String	rootTag()
void	toXML(Matrix<DIMENSION,VALUE_TYPE> matrix, XMLStreamWriter writer)

Methods inherited from class java.lang.Object

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

Field Detail

VALUATION

public static final String VALUATION

See Also:

Constant Field Values

ROW

public static final String ROW

See Also:

Constant Field Values

COLUMN

public static final String COLUMN

See Also:

Constant Field Values

Constructor Detail

MatrixParser

public MatrixParser()

Method Detail

rootTag

public abstract String rootTag()

dimensionTag

public abstract String dimensionTag()

buildDimension

public abstract DIMENSION buildDimension(XMCDA xmcda,
                                         String id)

dimensionID

public abstract String dimensionID(DIMENSION obj)

fromXML

public Matrix<DIMENSION,VALUE_TYPE> fromXML(XMCDA xmcda,
                                            StartElement startElement,
                                            XMLEventReader eventReader)
                                     throws XMLStreamException

Throws:

XMLStreamException

readRowsFromXML

public void readRowsFromXML(XMCDA xmcda,
                            Matrix<DIMENSION,VALUE_TYPE> matrix,
                            StartElement startElement,
                            XMLEventReader eventReader)
                     throws XMLStreamException

Throws:

XMLStreamException

readColumnsFromXML

public void readColumnsFromXML(XMCDA xmcda,
                               Matrix<DIMENSION,VALUE_TYPE> matrix,
                               DIMENSION row,
                               StartElement startElement,
                               XMLEventReader eventReader)
                        throws XMLStreamException

Throws:

XMLStreamException

columnsForRow

protected LinkedHashSet<DIMENSION> columnsForRow(Matrix<DIMENSION,VALUE_TYPE> matrix,
                                                 DIMENSION row)

Returns the columns having values in the matrix for the supplied row. We use this, instead of Matrix.getColumns(), to iterate on the columns in the same order as they were inserted i, the matrix (incl. when they were read from XML). This ensures that reading than writing an XMCDA ...Matrix tag produces the same XML structure and ordering (except for the formatting).

Parameters:

matrix -

row -

Returns:

toXML

public void toXML(Matrix<DIMENSION,VALUE_TYPE> matrix,
                  XMLStreamWriter writer)
           throws XMLStreamException

Throws:

XMLStreamException