org.exist.xmldb
Class RemoteXMLResource

java.lang.Object
  org.exist.xmldb.AbstractRemoteResource
      org.exist.xmldb.RemoteXMLResource

All Implemented Interfaces:

EXistResource, ExtendedResource, org.xmldb.api.base.Resource, org.xmldb.api.modules.XMLResource

public class RemoteXMLResource
extends AbstractRemoteResource
implements org.xmldb.api.modules.XMLResource

Field Summary

Fields inherited from interface org.xmldb.api.modules.XMLResource

RESOURCE_TYPE

Constructor Summary

RemoteXMLResource(RemoteCollection parent, int handle, int pos, XmldbURI docId, String id)

RemoteXMLResource(RemoteCollection parent, XmldbURI docId, String id)

Method Summary

Object	getContent()
Node	getContentAsDOM()
void	getContentAsSAX(ContentHandler handler)
void	getContentIntoAStream(OutputStream os) It saves the resource to the local stream given as input parameter.
DocumentType	getDocType()
String	getDocumentId()
Object	getExtendedContent() It returns an object representing the content, in the representation which needs less memory.
String	getId()
String	getNodeId()
String	getResourceType()
boolean	getSAXFeature(String arg0)
InputStream	getStreamContent() It returns an stream to the content, whichever it is its origin
long	getStreamLength() It returns the length of the content, whichever it is its origin
void	setContent(Object value)
void	setContentAsDOM(Node root)
ContentHandler	setContentAsSAX()
void	setDocType(DocumentType doctype)
void	setLexicalHandler(LexicalHandler handler)
void	setSAXFeature(String arg0, boolean arg1)
void	setXMLReader(XMLReader xmlReader) Sets the external XMLReader to use.

Methods inherited from class org.exist.xmldb.AbstractRemoteResource

freeLocalResources, getContentIntoAFile, getContentLength, getCreationTime, getExtendedContentLength, getLastModificationTime, getMimeType, getParentCollection, getPermissions, setContentLength, setMimeType, setPermissions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xmldb.api.base.Resource

getParentCollection

Constructor Detail

RemoteXMLResource

public RemoteXMLResource(RemoteCollection parent,
                         XmldbURI docId,
                         String id)
                  throws org.xmldb.api.base.XMLDBException

Throws:

org.xmldb.api.base.XMLDBException

RemoteXMLResource

public RemoteXMLResource(RemoteCollection parent,
                         int handle,
                         int pos,
                         XmldbURI docId,
                         String id)
                  throws org.xmldb.api.base.XMLDBException

Throws:

org.xmldb.api.base.XMLDBException

Method Detail

getContent

public Object getContent()
                  throws org.xmldb.api.base.XMLDBException

Specified by:

getContent in interface org.xmldb.api.base.Resource

Overrides:

getContent in class AbstractRemoteResource

Throws:

org.xmldb.api.base.XMLDBException

getContentAsDOM

public Node getContentAsDOM()
                     throws org.xmldb.api.base.XMLDBException

Specified by:

getContentAsDOM in interface org.xmldb.api.modules.XMLResource

Throws:

org.xmldb.api.base.XMLDBException

getContentAsSAX

public void getContentAsSAX(ContentHandler handler)
                     throws org.xmldb.api.base.XMLDBException

Specified by:

getContentAsSAX in interface org.xmldb.api.modules.XMLResource

Throws:

org.xmldb.api.base.XMLDBException

getNodeId

public String getNodeId()

getDocumentId

public String getDocumentId()
                     throws org.xmldb.api.base.XMLDBException

Specified by:

getDocumentId in interface org.xmldb.api.modules.XMLResource

Throws:

org.xmldb.api.base.XMLDBException

getId

public String getId()
             throws org.xmldb.api.base.XMLDBException

Specified by:

getId in interface org.xmldb.api.base.Resource

Throws:

org.xmldb.api.base.XMLDBException

getResourceType

public String getResourceType()
                       throws org.xmldb.api.base.XMLDBException

Specified by:

getResourceType in interface org.xmldb.api.base.Resource

Throws:

org.xmldb.api.base.XMLDBException

setXMLReader

public void setXMLReader(XMLReader xmlReader)

Sets the external XMLReader to use.

Parameters:

xmlReader - the XMLReader

setContent

public void setContent(Object value)
                throws org.xmldb.api.base.XMLDBException

Specified by:

setContent in interface org.xmldb.api.base.Resource

Throws:

org.xmldb.api.base.XMLDBException

setContentAsDOM

public void setContentAsDOM(Node root)
                     throws org.xmldb.api.base.XMLDBException

Specified by:

setContentAsDOM in interface org.xmldb.api.modules.XMLResource

Throws:

org.xmldb.api.base.XMLDBException

setContentAsSAX

public ContentHandler setContentAsSAX()
                               throws org.xmldb.api.base.XMLDBException

Specified by:

setContentAsSAX in interface org.xmldb.api.modules.XMLResource

Throws:

org.xmldb.api.base.XMLDBException

getSAXFeature

public boolean getSAXFeature(String arg0)
                      throws SAXNotRecognizedException,
                             SAXNotSupportedException

Specified by:

getSAXFeature in interface org.xmldb.api.modules.XMLResource

Throws:

SAXNotRecognizedException

SAXNotSupportedException

setSAXFeature

public void setSAXFeature(String arg0,
                          boolean arg1)
                   throws SAXNotRecognizedException,
                          SAXNotSupportedException

Specified by:

setSAXFeature in interface org.xmldb.api.modules.XMLResource

Throws:

SAXNotRecognizedException

SAXNotSupportedException

setLexicalHandler

public void setLexicalHandler(LexicalHandler handler)

Specified by:

setLexicalHandler in interface EXistResource

getDocType

public DocumentType getDocType()
                        throws org.xmldb.api.base.XMLDBException

Specified by:

getDocType in interface EXistResource

Throws:

org.xmldb.api.base.XMLDBException

setDocType

public void setDocType(DocumentType doctype)
                throws org.xmldb.api.base.XMLDBException

Specified by:

setDocType in interface EXistResource

Throws:

org.xmldb.api.base.XMLDBException

getContentIntoAStream

public void getContentIntoAStream(OutputStream os)
                           throws org.xmldb.api.base.XMLDBException

Description copied from interface: ExtendedResource

It saves the resource to the local stream given as input parameter. Do NOT confuse with set content.

Specified by:

getContentIntoAStream in interface ExtendedResource

Throws:

org.xmldb.api.base.XMLDBException

getExtendedContent

public Object getExtendedContent()
                          throws org.xmldb.api.base.XMLDBException

Description copied from interface: ExtendedResource

It returns an object representing the content, in the representation which needs less memory.

Specified by:

getExtendedContent in interface ExtendedResource

Throws:

org.xmldb.api.base.XMLDBException

getStreamContent

public InputStream getStreamContent()
                             throws org.xmldb.api.base.XMLDBException

Description copied from interface: ExtendedResource

It returns an stream to the content, whichever it is its origin

Specified by:

getStreamContent in interface ExtendedResource

Throws:

org.xmldb.api.base.XMLDBException

getStreamLength

public long getStreamLength()
                     throws org.xmldb.api.base.XMLDBException

Description copied from interface: ExtendedResource

It returns the length of the content, whichever it is its origin

Specified by:

getStreamLength in interface ExtendedResource

Throws:

org.xmldb.api.base.XMLDBException