org.x4o.xml.io

Interface X4OReader<T>

All Superinterfaces:

X4OConnection

All Known Subinterfaces:

X4OReaderContext<T>

All Known Implementing Classes:

AbstractX4OReader, AbstractX4OReaderContext, DefaultX4OReader

public interface X4OReader<T>
extends X4OConnection

X4OReader can read different input formats.

Version:

1.0 Apr 6, 2013

Author:

Willem Cazander

Method Summary

Methods

Modifier and Type	Method and Description
void	addELBeanInstance(String name, Object bean) Adds an bean instance to the el context.
T	read(InputStream input, String systemId, URL basePath) Method to parse the xml data.
T	readFile(File file) Reads the file and parses it as an InputStream.
T	readFile(String fileName) Reads the file fileName and parses it as an InputStream.
T	readResource(String resourceName) Parses an resource locaction.
T	readString(String xmlString) Converts a String to a InputStream to is can me parsed by SAX.
T	readUrl(URL url) Fetched the data direct from remote url to a InputStream to is can me parsed by SAX.

Methods inherited from interface org.x4o.xml.io.X4OConnection

getProperty, getPropertyKeySet, setProperty

Method Detail

addELBeanInstance

void addELBeanInstance(String name,
                     Object bean)

Adds an bean instance to the el context.

Parameters:

name - The el name for the bean.

bean - The bean to add to the el context.

read

T read(InputStream input,
     String systemId,
     URL basePath)
       throws X4OConnectionException,
              SAXException,
              IOException

Method to parse the xml data.

Parameters:

input - The inputStream to parse.

Throws:

X4OConnectionException - Is thrown after x4o exception.

SAXException - Is thrown after sax xml exception.

IOException - Is thrown after io exception.

readFile

T readFile(String fileName)
           throws X4OConnectionException,
                  SAXException,
                  IOException,
                  FileNotFoundException

Reads the file fileName and parses it as an InputStream.

Parameters:

fileName - The file name to parse.

Throws:

FileNotFoundException - Is thrown is file is not found.

X4OConnectionException - Is thrown after x4o exception.

SAXException - Is thrown after sax xml exception.

IOException - Is thrown after io exception.

See Also:

X4OReaderContext.readContext(java.io.InputStream,java.lang.String,java.net.URL)

readFile

T readFile(File file)
           throws X4OConnectionException,
                  SAXException,
                  IOException,
                  FileNotFoundException

Reads the file and parses it as an InputStream.

Parameters:

file - The file to parse.

Throws:

FileNotFoundException - Is thrown is file is not found.

X4OConnectionException - Is thrown after x4o exception.

SAXException - Is thrown after sax xml exception.

IOException - Is thrown after io exception.

See Also:

X4OReaderContext.readContext(java.io.InputStream,java.lang.String,java.net.URL)

readResource

T readResource(String resourceName)
               throws X4OConnectionException,
                      SAXException,
                      IOException

Parses an resource locaction.

Parameters:

resourceName - The resource to parser.

Throws:

X4OConnectionException - Is thrown after x4o exception.

SAXException - Is thrown after sax xml exception.

IOException - Is thrown after io exception.

See Also:

X4OReaderContext.readContext(java.io.InputStream,java.lang.String,java.net.URL)

readString

T readString(String xmlString)
             throws X4OConnectionException,
                    SAXException,
                    IOException

Converts a String to a InputStream to is can me parsed by SAX.

Parameters:

xmlString - The xml as String to parse.

Throws:

X4OConnectionException - Is thrown after x4o exception.

SAXException - Is thrown after sax xml exception.

IOException - Is thrown after io exception.

See Also:

X4OReaderContext.readContext(java.io.InputStream,java.lang.String,java.net.URL)

readUrl

T readUrl(URL url)
          throws X4OConnectionException,
                 SAXException,
                 IOException

Fetched the data direct from remote url to a InputStream to is can me parsed by SAX.

Parameters:

url - The url to parse.

Throws:

X4OConnectionException - Is thrown after x4o exception.

SAXException - Is thrown after sax xml exception.

IOException - Is thrown after io exception.

See Also:

X4OReaderContext.readContext(java.io.InputStream,java.lang.String,java.net.URL)