org.xmlbeam

Interface ProjectionIO

public interface ProjectionIO

A ProjectionIO is responsible for every IO operation related to projections. Before coding your own IO implementation, you should have a look at the tutorials for usage examples.

Method Summary

Modifier and Type	Method and Description
XBFileIO	file(File file) Get access to the file IO.
XBFileIO	file(String fileName) Get access to the file IO.
<T> T	fromURLAnnotation(Class<T> projectionInterface, Object... optionalParams) Create a new projection using a XBDocURL annotation on this interface.
XBStreamInput	stream(InputStream is) Get access to the stream IO
XBStreamOutput	stream(OutputStream os) Get access to the stream IO
String	toURLAnnotationViaPOST(Object projection, Object... optionalParams) Write projection document to url (file or http post) of XBDocURL annotation.
XBUrlIO	url(String url) Get access to the url IO.

Method Detail

file

XBFileIO file(File file)

Get access to the file IO.

Parameters:

file -

Returns:

a XBFileIO for this file.

file

XBFileIO file(String fileName)

Get access to the file IO.

Parameters:

fileName -

Returns:

a XBFileIO for this filename.

url

XBUrlIO url(String url)

Get access to the url IO.

Parameters:

url -

Returns:

a XBUrlIO for this url

stream

XBStreamInput stream(InputStream is)

Get access to the stream IO

Parameters:

is -

Returns:

a XBStreamInput for this InputStream

stream

XBStreamOutput stream(OutputStream os)

Get access to the stream IO

Parameters:

os -

Returns:

a XBStreamOutput for this OutputStream

fromURLAnnotation

<T> T fromURLAnnotation(Class<T> projectionInterface,
                        Object... optionalParams)
                 throws IOException

Create a new projection using a XBDocURL annotation on this interface. When the XBDocURL starts with the protocol identifier "resource://" the class loader of the projection interface will be used to read the resource from the current class path.

Parameters:

projectionInterface - a public interface.

optionalParams -

Returns:

a new projection instance

Throws:

IOException

toURLAnnotationViaPOST

String toURLAnnotationViaPOST(Object projection,
                              Object... optionalParams)
                       throws IOException,
                              URISyntaxException

Write projection document to url (file or http post) of XBDocURL annotation.

Parameters:

projection -

optionalParams -

Returns:

response of http post or null for file urls.

Throws:

IOException

URISyntaxException