org.xmldb.api.base
Interface Resource
- BinaryResource, XMLResource
- BaseResource, BinaryResourceImpl, SimpleBinaryResource, SimpleXMLResource, XMLResourceImpl
public interface Resource
Resource
is a container for data stored within the database. Raw resources
are not particulary useful. It is necessary to have a resource implementation
that provides handling for a specific content type before anything useful can
be done.
Object | getContent() - Retrieves the content from the resource.
|
String | getId() - Returns the unique id for this
Resource or null if the
Resource is anonymous.
|
Collection | getParentCollection() - Returns the
Collection instance that this resource is
associated with.
|
String | getResourceType() - Returns the resource type for this Resource.
|
void | setContent(Object value) - Sets the content for this resource.
|
getContent
public Object getContent()
throws XMLDBException
Retrieves the content from the resource. The type of the content varies
depending what type of resource is being used.
- the content of the resource.
XMLDBException
- with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
getId
public String getId()
throws XMLDBException
Returns the unique id for this Resource
or null if the
Resource
is anonymous. The Resource
will be
anonymous if it is obtained as the result of a query.
- the id for the Resource or null if no id exists.
XMLDBException
- with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
getParentCollection
public Collection getParentCollection()
throws XMLDBException
Returns the Collection
instance that this resource is
associated with. All resources must exist within the context of a
collection
.
- the collection associated with the resource.
XMLDBException
- with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
getResourceType
public String getResourceType()
throws XMLDBException
Returns the resource type for this Resource.
XML:DB defined resource types are:
XMLResource - all XML data stored in the database
BinaryResource - Binary blob data stored in the database
- the resource type for the Resource.
XMLDBException
- with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.
setContent
public void setContent(Object value)
throws XMLDBException
Sets the content for this resource. The type of content that can be set
depends on the type of resource being used.
value
- the content value to set for the resource.
XMLDBException
- with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.