org.xmcda.parsers.xml.xmcda_v3

Class XMCDAParser

java.lang.Object

org.xmcda.parsers.xml.xmcda_v3.XMCDAParser

public class XMCDAParser
extends Object

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
XMCDAParser()

Method Summary

Modifier and Type	Method and Description
static Version	getDefaultXMCDAv3Version()
static void	main(String[] args)
protected XMCDA	readXMCDA_noValidation(XMCDA xmcda, InputStream inputStream, Set<String> parsedRootElements, String... tagsOnly) Parses an input stream and populate the supplied XMCDA objects with the elements found in the stream. Parameters: see readXMCDA(XMCDA, InputStream, Set, String...).
XMCDA	readXMCDA(XMCDA xmcda, File file)
XMCDA	readXMCDA(XMCDA xmcda, File file, Set<String> parsedRootElements, String... tagsOnly) Reads a XMCDA file and adds its content to an XMCDA object.
XMCDA	readXMCDA(XMCDA xmcda, File file, String... tagsOnly)
protected XMCDA	readXMCDA(XMCDA xmcda, InputStream inputStream, Set<String> parsedRootElements, String... tagsOnly) Validates and parses an inputStream to build a XMCDA object.
XMCDA	readXMCDA(XMCDA xmcda, String filename)
XMCDA	readXMCDA(XMCDA xmcda, String filename, String... tags)
static void	setDefaultXMCDAv3Version(Version version)
static boolean	validate(File file)
protected static boolean	validate(InputStream inputStream)
protected static boolean	validate(StreamSource streamSource)
void	writeXMCDA(XMCDA xmcda, File contextFile)
void	writeXMCDA(XMCDA xmcda, File contextFile, String... tagsOnly)
void	writeXMCDA(XMCDA xmcda, OutputStream stream, String... tagsOnly)
void	writeXMCDA(XMCDA xmcda, OutputStream stream, Version version, String... tagsOnly)
void	writeXMCDA(XMCDA xmcda, String contextFileName)
void	writeXMCDA(XMCDA xmcda, String contextFileName, String... tagsOnly)

Methods inherited from class java.lang.Object

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

Field Detail

readXMCDAInputStreamMaxSize

protected int readXMCDAInputStreamMaxSize

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

XMCDAv3_VERSION

public static final String XMCDAv3_VERSION

See Also:

Constant Field Values

Constructor Detail

XMCDAParser

public XMCDAParser()

Method Detail

validate

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

Throws:

IOException

SAXException

validate

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

Throws:

IOException

SAXException

validate

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

Throws:

IOException

SAXException

readXMCDA

public XMCDA readXMCDA(XMCDA xmcda,
                       String filename)
                throws IOException,
                       XMLStreamException,
                       SAXException

Throws:

IOException

XMLStreamException

SAXException

readXMCDA

public XMCDA readXMCDA(XMCDA xmcda,
                       String filename,
                       String... tags)
                throws IOException,
                       XMLStreamException,
                       SAXException

Throws:

IOException

XMLStreamException

SAXException

readXMCDA

public XMCDA readXMCDA(XMCDA xmcda,
                       File file)
                throws IOException,
                       XMLStreamException,
                       SAXException

Throws:

IOException

XMLStreamException

SAXException

readXMCDA

public XMCDA readXMCDA(XMCDA xmcda,
                       File file,
                       String... tagsOnly)
                throws IOException,
                       XMLStreamException,
                       SAXException

Throws:

IOException

XMLStreamException

SAXException

readXMCDA

public XMCDA readXMCDA(XMCDA xmcda,
                       File file,
                       Set<String> parsedRootElements,
                       String... tagsOnly)
                throws IOException,
                       XMLStreamException,
                       SAXException

Reads a XMCDA file and adds its content to an XMCDA object.

Parameters:

xmcda - the XMCDA object on which the parsed elements will be put into

file - the files containing the XMCDA to be read

parsedRootElements - if non-null, the parsed root elements are appended to this list

tagsOnly - the list of root tags to read. If empty, everything is read

Returns:

the object passed as parameter xmcda

Throws:

IOException

XMLStreamException

SAXException

readXMCDA

protected XMCDA readXMCDA(XMCDA xmcda,
                          InputStream inputStream,
                          Set<String> parsedRootElements,
                          String... tagsOnly)
                   throws IOException,
                          XMLStreamException,
                          SAXException

Validates and parses an inputStream to build a XMCDA object.
Warning: the method works for small inputs only, it relies on an internal buffer whose size is readXMCDAInputStreamMaxSize.

Parameters:

xmcda - the XMCDA object in which the read elements should be put.

inputStream - the stream to read

parsedRootElements - a set in which the method puts the elements it parses. It mayu be null.

tagsOnly - the XMCDA root tags to be read in the stream. If null or empty,

Returns:

the updated XMCDA object supplied as a parameter

Throws:

IOException

XMLStreamException

SAXException

readXMCDA_noValidation

protected XMCDA readXMCDA_noValidation(XMCDA xmcda,
                                       InputStream inputStream,
                                       Set<String> parsedRootElements,
                                       String... tagsOnly)
                                throws IOException,
                                       XMLStreamException,
                                       SAXException

Parses an input stream and populate the supplied XMCDA objects with the elements found in the stream.
Parameters: see readXMCDA(XMCDA, InputStream, Set, String...).

Throws:

IOException

XMLStreamException

SAXException

getDefaultXMCDAv3Version

public static Version getDefaultXMCDAv3Version()

setDefaultXMCDAv3Version

public static void setDefaultXMCDAv3Version(Version version)

writeXMCDA

public void writeXMCDA(XMCDA xmcda,
                       String contextFileName)
                throws FileNotFoundException,
                       XMLStreamException

Throws:

FileNotFoundException

XMLStreamException

writeXMCDA

public void writeXMCDA(XMCDA xmcda,
                       String contextFileName,
                       String... tagsOnly)
                throws FileNotFoundException,
                       XMLStreamException

Throws:

FileNotFoundException

XMLStreamException

writeXMCDA

public void writeXMCDA(XMCDA xmcda,
                       File contextFile)
                throws FileNotFoundException,
                       XMLStreamException

Throws:

FileNotFoundException

XMLStreamException

writeXMCDA

public void writeXMCDA(XMCDA xmcda,
                       File contextFile,
                       String... tagsOnly)
                throws FileNotFoundException,
                       XMLStreamException

Throws:

FileNotFoundException

XMLStreamException

writeXMCDA

public void writeXMCDA(XMCDA xmcda,
                       OutputStream stream,
                       String... tagsOnly)
                throws FileNotFoundException,
                       XMLStreamException

Throws:

FileNotFoundException

XMLStreamException

writeXMCDA

public void writeXMCDA(XMCDA xmcda,
                       OutputStream stream,
                       Version version,
                       String... tagsOnly)
                throws FileNotFoundException,
                       XMLStreamException

Throws:

FileNotFoundException

XMLStreamException

main

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

Throws:

Throwable