org.xmcda.parsers.xml.xmcda_v2

Class XMCDAParser

java.lang.Object

org.xmcda.parsers.xml.xmcda_v2.XMCDAParser

public class XMCDAParser
extends Object

Author:

Sébastien Bigaret

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	readXMCDAInputStreamMaxSize The maximum size of the stream that can be read by #readXMCDA(XMCDA, InputStream, Set, String...)
static String	XMCDAv2_VERSION

Constructor Summary

Constructors

Constructor and Description
XMCDAParser()

Method Summary

Modifier and Type	Method and Description
static Version	getDefaultXMCDAv2Version()
static void	main(String[] args)
protected static XMCDA	readXMCDA_noValidation(InputStream inputStream, String... tagsOnly)
static XMCDA	readXMCDA(File file) Reads an XMCDA file and builds the corresponding XMCDA object.
static XMCDA	readXMCDA(File file, String... tagsOnly) Reads an XMCDA file and builds the corresponding XMCDA object from it, keeping the tags in tagsOnly only (all others are filtered out).
protected static XMCDA	readXMCDA(InputStream inputStream, String... tagsOnly)
static XMCDA	readXMCDA(String filename)
static XMCDA	readXMCDA(String filename, String... tagsOnly) Reads an XMCDA file and builds the corresponding XMCDA object from it, keeping the tags in tagsOnly only.
static Set<String>	rootTags(XMCDA xmcda_v2) Returns the list of the root tags present in xmcda_v2.
static void	setDefaultXMCDAv2Version(Version version)
static void	validate(File file)
protected static void	validate(InputStream inputStream)
protected static void	validate(StreamSource streamSource)
static void	writeXMCDA(XMCDA xmcda, File file)
static void	writeXMCDA(XMCDA xmcda, File file, String... tagsOnly)
static void	writeXMCDA(XMCDA xmcda, File file, Version version, String... tagsOnly)
static void	writeXMCDA(XMCDA xmcda, String filename)
static void	writeXMCDA(XMCDA xmcda, String filename, String... tagsOnly)

Methods inherited from class java.lang.Object

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

Field Detail

readXMCDAInputStreamMaxSize

protected static int readXMCDAInputStreamMaxSize

The maximum size of the stream that can be read by #readXMCDA(XMCDA, InputStream, Set, String...)

XMCDAv2_VERSION

public static final String XMCDAv2_VERSION

See Also:

Constant Field Values

Constructor Detail

XMCDAParser

public XMCDAParser()

Method Detail

readXMCDA

public static XMCDA readXMCDA(String filename)
                       throws IOException,
                              JAXBException,
                              SAXException

Throws:

IOException

JAXBException

SAXException

readXMCDA

public static XMCDA readXMCDA(String filename,
                              String... tagsOnly)
                       throws IOException,
                              JAXBException,
                              SAXException

Reads an XMCDA file and builds the corresponding XMCDA object from it, keeping the tags in tagsOnly only.

Parameters:

filename - the name of the XMCDA file to read

tagsOnly - the list of tags that should be read from the file

Returns:

the XMCDA object build from the file where XML tags not in tagsOnly are filtered out.

Throws:

FileNotFoundException

JAXBException

SAXException

IOException

readXMCDA

public static XMCDA readXMCDA(File file)
                       throws JAXBException,
                              IOException,
                              SAXException

Reads an XMCDA file and builds the corresponding XMCDA object.

Parameters:

file - the XMCDA file to read

Throws:

JAXBException

FileNotFoundException

SAXException

IOException

readXMCDA

public static XMCDA readXMCDA(File file,
                              String... tagsOnly)
                       throws IOException,
                              JAXBException,
                              SAXException

Reads an XMCDA file and builds the corresponding XMCDA object from it, keeping the tags in tagsOnly only (all others are filtered out).

Parameters:

file - the XMCDA v2 file to read and load

tagsOnly - a list of XMCDA root tags to keep

Returns:

the XMCDA v2 object

Throws:

IOException

JAXBException

SAXException

validate

public static void validate(File file)
                     throws IOException,
                            SAXException

Throws:

IOException

SAXException

validate

protected static void validate(InputStream inputStream)
                        throws IOException,
                               SAXException

Throws:

IOException

SAXException

validate

protected static void validate(StreamSource streamSource)
                        throws IOException,
                               SAXException

Throws:

IOException

SAXException

readXMCDA

protected static XMCDA readXMCDA(InputStream inputStream,
                                 String... tagsOnly)
                          throws IOException,
                                 JAXBException,
                                 SAXException

Throws:

IOException

JAXBException

SAXException

readXMCDA_noValidation

protected static XMCDA readXMCDA_noValidation(InputStream inputStream,
                                              String... tagsOnly)
                                       throws JAXBException

Throws:

JAXBException

getDefaultXMCDAv2Version

public static Version getDefaultXMCDAv2Version()

setDefaultXMCDAv2Version

public static void setDefaultXMCDAv2Version(Version version)

writeXMCDA

public static void writeXMCDA(XMCDA xmcda,
                              String filename)
                       throws JAXBException

Throws:

JAXBException

writeXMCDA

public static void writeXMCDA(XMCDA xmcda,
                              String filename,
                              String... tagsOnly)
                       throws JAXBException

Throws:

JAXBException

writeXMCDA

public static void writeXMCDA(XMCDA xmcda,
                              File file)
                       throws JAXBException

Throws:

JAXBException

writeXMCDA

public static void writeXMCDA(XMCDA xmcda,
                              File file,
                              String... tagsOnly)
                       throws JAXBException

Throws:

JAXBException

writeXMCDA

public static void writeXMCDA(XMCDA xmcda,
                              File file,
                              Version version,
                              String... tagsOnly)
                       throws JAXBException

Throws:

JAXBException

rootTags

public static Set<String> rootTags(XMCDA xmcda_v2)

Returns the list of the root tags present in xmcda_v2.

Parameters:

xmcda_v2 - the XMCDA v2 object to examine

Returns:

The list of root tags present in xmcda_v2

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception