net.sf.saxon.resource

Class BinaryResource

java.lang.Object

net.sf.saxon.resource.BinaryResource

All Implemented Interfaces:

Resource

public class BinaryResource
extends Object
implements Resource

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceFactory	FACTORY ResourceFactory suitable for creating a BinaryResource

Constructor Summary

Constructors

Constructor and Description
BinaryResource(String href, String contentType, InputStream in) Create a binary resource

Method Summary

Modifier and Type	Method and Description
String	getContentType() Get the media type (MIME type) of the resource if known
byte[]	getData() Get the content of the resource as an array of bytes
Item	getItem(XPathContext context) Get an XDM Item holding the contents of this resource.
String	getResourceURI() Get the URI of the resource
static byte[]	readBinaryFromStream(InputStream in, String path) Utility method to construct an array of bytes from the content of an InputStream
void	setData(byte[] data) Set the content of the resource as an array of bytes

Methods inherited from class java.lang.Object

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

Field Detail

FACTORY

public static final ResourceFactory FACTORY

ResourceFactory suitable for creating a BinaryResource

Constructor Detail

BinaryResource

public BinaryResource(String href,
                      String contentType,
                      InputStream in)

Create a binary resource

Parameters:

href - the URI of the resource

contentType - the media type of the resource

in - inputStream containing the binary content of the resource. Note that the InputStream is not consumed by this method, but is retained for use by the getItem() method.

Method Detail

setData

public void setData(byte[] data)

Set the content of the resource as an array of bytes

Parameters:

data - the content of the resource

getData

public byte[] getData()

Get the content of the resource as an array of bytes

Returns:

the content (if it has been set using setData())

getResourceURI

public String getResourceURI()

Get the URI of the resource

Specified by:

getResourceURI in interface Resource

Returns:

the URI of the resource

readBinaryFromStream

public static byte[] readBinaryFromStream(InputStream in,
                                          String path)
                                   throws XPathException

Utility method to construct an array of bytes from the content of an InputStream

Parameters:

in - the input stream. The method consumes the input stream but does not close it.

path - file name or URI used only for diagnostics

Returns:

byte array representing the content of the InputStream

Throws:

XPathException

getItem

public Item getItem(XPathContext context)
             throws XPathException

Description copied from interface: Resource

Get an XDM Item holding the contents of this resource.

Specified by:

getItem in interface Resource

Parameters:

context - the XPath evaluation context

Returns:

an item holding the contents of the resource. The type of item will reflect the type of the resource: a document node for XML resources, a string for text resources, a map or array for JSON resources, a base64Binary value for binary resource. May also return null if the resource cannot be materialized and this is not to be treated as an error.

Throws:

XPathException - if a failure occurs materializing the resource

getContentType

public String getContentType()

Description copied from interface: Resource

Get the media type (MIME type) of the resource if known

Specified by:

getContentType in interface Resource

Returns:

the media type if known; otherwise null