com.highqsoft.mdf

Class MDFHeaderFactory

java.lang.Object

com.highqsoft.mdf.MDFHeaderFactory

public class MDFHeaderFactory
extends java.lang.Object

This is header factory for MDF files following the MDF 3.0 specification. The main method can be used to display the header comment. Just pass the MDF file as first argument.

Since:

$Date: 2017/04/06 13:29:27 $

Version:

$Revision: 1.25 $

Author:

Andreas Hofmann

See Also:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MDFHeaderFactory.ReaderResult The result of the reader process.
static class	MDFHeaderFactory.StreamReader
protected class	MDFHeaderFactory.TimeOut Class to timeout MDFReader process.
static class	MDFHeaderFactory.VHandler The validation handler to the XML reader.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	filename

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MDFHeaderFactory() The default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static org.w3c.dom.Element	getElementByName(org.w3c.dom.Element element, java.lang.String name) Get a named node element.
static org.w3c.dom.Element	getElementByName(org.w3c.dom.Element element, java.lang.String name, java.lang.String attr) Get a named node element.
MDFHeader	getHeader(java.lang.String filename) Get the MDFHeader object belongs to the given filename.
static MDFHeaderFactory	getInstance() Get an instance of the facgtory.
static void	main(java.lang.String[] args) The main testing method.
org.w3c.dom.Document	parse(java.lang.String filename) Get the DOM from MDF file header.
MDFHeader	read(java.lang.String mdfFilename) Get the DOM from MDF file header.
static java.lang.Object	readXML(java.io.InputStream stream, java.lang.String packageName, java.lang.String schemaResource, java.util.logging.Logger logger, java.lang.String loggerPrefix) Read from input stream.
static java.lang.Object	readXML(java.lang.String resource, java.lang.String packageName, java.lang.String schemaResource, java.util.logging.Logger logger) Read an XML file.
void	setXMLFilename(java.lang.String filename) Set the filename to read the XML from.

Methods inherited from class java.lang.Object

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

Field Detail

filename

protected java.lang.String filename

Constructor Detail

MDFHeaderFactory

protected MDFHeaderFactory()

The default constructor.

Method Detail

getInstance

public static MDFHeaderFactory getInstance()

Get an instance of the facgtory.

Returns:

the singleton instance of the factory.

setXMLFilename

public void setXMLFilename(java.lang.String filename)

Set the filename to read the XML from. This XML file must be created by the MDFReader executable and must belong to the given MDF file.

Parameters:

filename - the XML filename. If this filename is null the XML stream will be generated by the MDFReader executable directly.

parse

public org.w3c.dom.Document parse(java.lang.String filename)
                           throws java.io.IOException,
                                  javax.xml.parsers.ParserConfigurationException,
                                  org.xml.sax.SAXException

Get the DOM from MDF file header. The method expect an XML file containing the output of the MDFReader to get an XML stream of the MDF header.

Parameters:

filename - The MDF header XML file

Returns:

the document object model of the header

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

read

public MDFHeader read(java.lang.String mdfFilename)
               throws javax.xml.bind.JAXBException,
                      java.io.IOException,
                      java.io.FileNotFoundException

Get the DOM from MDF file header. The method uses the MDFReader to get an XML stream of the MDF header.

Parameters:

filename - The MDF file

Returns:

the document object model of the header

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

javax.xml.bind.JAXBException

java.io.FileNotFoundException

getHeader

public MDFHeader getHeader(java.lang.String filename)
                    throws javax.xml.bind.JAXBException,
                           java.io.IOException,
                           java.io.FileNotFoundException

Get the MDFHeader object belongs to the given filename.

Parameters:

filename - the MDF filename

Returns:

the MDF header

Throws:

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

javax.xml.bind.JAXBException

java.io.FileNotFoundException

getElementByName

public static org.w3c.dom.Element getElementByName(org.w3c.dom.Element element,
                                   java.lang.String name)

Get a named node element.

Returns:

The found node element.

getElementByName

public static org.w3c.dom.Element getElementByName(org.w3c.dom.Element element,
                                   java.lang.String name,
                                   java.lang.String attr)

Get a named node element.

Returns:

The found node element.

readXML

public static java.lang.Object readXML(java.lang.String resource,
                       java.lang.String packageName,
                       java.lang.String schemaResource,
                       java.util.logging.Logger logger)
                                throws javax.xml.bind.JAXBException,
                                       java.io.IOException,
                                       java.io.FileNotFoundException

Read an XML file.

Parameters:

resource - The name of the file or a resource.

packageName - The package name to be used for marshaling.

schemaResource - The resource of the schema

logger - A logger to be used when schema validation problem exist.

Returns:

The object that was unmarshaled.

Throws:

javax.xml.bind.JAXBException

java.io.IOException

java.io.FileNotFoundException

readXML

public static java.lang.Object readXML(java.io.InputStream stream,
                       java.lang.String packageName,
                       java.lang.String schemaResource,
                       java.util.logging.Logger logger,
                       java.lang.String loggerPrefix)
                                throws javax.xml.bind.JAXBException,
                                       java.io.IOException,
                                       java.io.FileNotFoundException

Read from input stream.

Parameters:

stream - the input stream.

packageName - The package name to be used for marshaling.

schemaResource - The resource of the schema

logger - A logger to be used when schema validation problem exist.

Returns:

The object that was unmarshaled.

Throws:

javax.xml.bind.JAXBException

java.io.IOException

java.io.FileNotFoundException

main

public static void main(java.lang.String[] args)

The main testing method.

Parameters:

args - the command line arguments. The first argument must be the name of the MDF file or a XML file containing the output of the MDFReader.