|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.xmldb.AbstractEXistResource
org.exist.xmldb.LocalXMLResource
Local implementation of XMLResource.
Field Summary |
Fields inherited from interface org.xmldb.api.modules.XMLResource |
RESOURCE_TYPE |
Constructor Summary | |
LocalXMLResource(User user,
BrokerPool pool,
LocalCollection parent,
NodeProxy p)
|
|
LocalXMLResource(User user,
BrokerPool pool,
LocalCollection parent,
XmldbURI did)
|
Method Summary | |
java.lang.Object |
getContent()
Retrieves the content from the resource. |
org.w3c.dom.Node |
getContentAsDOM()
Returns the content of the Resource as a DOM Node. |
void |
getContentAsSAX(org.xml.sax.ContentHandler handler)
Allows you to use a ContentHandler to parse the XML data from
the database for use in an application. |
int |
getContentLength()
|
java.util.Date |
getCreationTime()
|
org.w3c.dom.DocumentType |
getDocType()
|
java.lang.String |
getDocumentId()
Returns the unique id for the parent document to this Resource
or null if the Resource does not have a parent document. |
java.lang.String |
getId()
Returns the unique id for this Resource or null if the
Resource is anonymous. |
java.util.Date |
getLastModificationTime()
|
NodeProxy |
getNode()
|
Collection |
getParentCollection()
Returns the Collection instance that this resource is
associated with. |
Permission |
getPermissions()
|
java.lang.String |
getResourceType()
Returns the resource type for this Resource. |
boolean |
getSAXFeature(java.lang.String arg0)
Returns current setting of a SAX feature that will be used when this XMLResource is used to produce SAX events (through the
getContentAsSAX() method) |
void |
setContent(java.lang.Object obj)
Sets the content for this resource. |
void |
setContentAsDOM(org.w3c.dom.Node root)
Sets the content of the Resource using a DOM Node as the
source. |
org.xml.sax.ContentHandler |
setContentAsSAX()
Sets the content of the Resource using a SAX
ContentHandler . |
void |
setDocType(org.w3c.dom.DocumentType doctype)
|
void |
setLexicalHandler(org.xml.sax.ext.LexicalHandler handler)
|
void |
setSAXFeature(java.lang.String arg0,
boolean arg1)
Sets a SAX feature that will be used when this XMLResource
is used to produce SAX events (through the getContentAsSAX() method) |
Methods inherited from class org.exist.xmldb.AbstractEXistResource |
getMimeType, setMimeType |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public LocalXMLResource(User user, BrokerPool pool, LocalCollection parent, XmldbURI did) throws XMLDBException
public LocalXMLResource(User user, BrokerPool pool, LocalCollection parent, NodeProxy p) throws XMLDBException
Method Detail |
public java.lang.Object getContent() throws XMLDBException
Resource
getContent
in interface Resource
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public org.w3c.dom.Node getContentAsDOM() throws XMLDBException
XMLResource
Resource
as a DOM Node.
getContentAsDOM
in interface XMLResource
Node
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public void getContentAsSAX(org.xml.sax.ContentHandler handler) throws XMLDBException
XMLResource
ContentHandler
to parse the XML data from
the database for use in an application.
getContentAsSAX
in interface XMLResource
handler
- the SAX ContentHandler
to use to handle the
Resource
content.
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.ErrorCodes.INVALID_RESOURCE
if the
ContentHandler
provided is null.public java.lang.String getDocumentId() throws XMLDBException
XMLResource
Resource
or null if the Resource
does not have a parent document.
getDocumentId()
is typically used with Resource
instances retrieved using a query. It enables accessing the parent
document of the Resource
even if the Resource
is
a child node of the document. If the Resource
was not
obtained through a query then getId()
and
getDocumentId()
will return the same id.
getDocumentId
in interface XMLResource
Resource
or
null if there is no parent document for this Resource
.
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public java.lang.String getId() throws XMLDBException
Resource
Resource
or null if the
Resource
is anonymous. The Resource
will be
anonymous if it is obtained as the result of a query.
getId
in interface Resource
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public Collection getParentCollection() throws XMLDBException
Resource
Collection
instance that this resource is
associated with. All resources must exist within the context of a
collection
.
getParentCollection
in interface Resource
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public java.lang.String getResourceType() throws XMLDBException
Resource
getResourceType
in interface Resource
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public java.util.Date getCreationTime() throws XMLDBException
getCreationTime
in interface EXistResource
getCreationTime
in class AbstractEXistResource
XMLDBException
public java.util.Date getLastModificationTime() throws XMLDBException
getLastModificationTime
in interface EXistResource
getLastModificationTime
in class AbstractEXistResource
XMLDBException
public int getContentLength() throws XMLDBException
getContentLength
in interface EXistResource
XMLDBException
public void setContent(java.lang.Object obj) throws XMLDBException
setContent
in interface Resource
obj
- the content value to set for the resource.
XMLDBException
- with expected error codes. ErrorCodes.VENDOR_ERROR
for any vendor specific errors that occur. public void setContentAsDOM(org.w3c.dom.Node root) throws XMLDBException
XMLResource
Resource
using a DOM Node as the
source.
setContentAsDOM
in interface XMLResource
root
- The new content value
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.ErrorCodes.INVALID_RESOURCE
if the content value provided is
null.ErrorCodes.WRONG_CONTENT_TYPE
if the content provided in not
a valid DOM Node
.public org.xml.sax.ContentHandler setContentAsSAX() throws XMLDBException
XMLResource
Resource
using a SAX
ContentHandler
.
setContentAsSAX
in interface XMLResource
ContentHandler
that can be used to add content
into the Resource
.
XMLDBException
- with expected error codes.ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.public boolean getSAXFeature(java.lang.String arg0) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
XMLResource
XMLResource
is used to produce SAX events (through the
getContentAsSAX() method)
getSAXFeature
in interface XMLResource
arg0
- Feature name. Standard SAX feature names are documented at
http://sax.sourceforge.net/.
org.xml.sax.SAXNotRecognizedException
org.xml.sax.SAXNotSupportedException
public void setSAXFeature(java.lang.String arg0, boolean arg1) throws org.xml.sax.SAXNotRecognizedException, org.xml.sax.SAXNotSupportedException
XMLResource
XMLResource
is used to produce SAX events (through the getContentAsSAX() method)
setSAXFeature
in interface XMLResource
arg0
- Feature name. Standard SAX feature names are documented at
http://sax.sourceforge.net/.arg1
- Set or unset feature
org.xml.sax.SAXNotRecognizedException
org.xml.sax.SAXNotSupportedException
public Permission getPermissions() throws XMLDBException
getPermissions
in interface EXistResource
getPermissions
in class AbstractEXistResource
XMLDBException
public void setLexicalHandler(org.xml.sax.ext.LexicalHandler handler)
setLexicalHandler
in interface EXistResource
setLexicalHandler
in class AbstractEXistResource
public NodeProxy getNode() throws XMLDBException
XMLDBException
public org.w3c.dom.DocumentType getDocType() throws XMLDBException
getDocType
in interface EXistResource
getDocType
in class AbstractEXistResource
XMLDBException
public void setDocType(org.w3c.dom.DocumentType doctype) throws XMLDBException
setDocType
in interface EXistResource
setDocType
in class AbstractEXistResource
XMLDBException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |