| org.dspace.content.crosswalk.DisseminationCrosswalk
All known Subclasses: org.dspace.content.crosswalk.MODSDisseminationCrosswalk, org.dspace.content.crosswalk.PREMISCrosswalk, org.dspace.content.crosswalk.QDCCrosswalk, org.dspace.content.crosswalk.SimpleDCDisseminationCrosswalk, org.dspace.content.crosswalk.XSLTDisseminationCrosswalk, org.dspace.content.crosswalk.XHTMLHeadDisseminationCrosswalk, org.dspace.content.crosswalk.METSDisseminationCrosswalk,
| DisseminationCrosswalk | | public interface DisseminationCrosswalk (Code) | | Dissemination Crosswalk plugin -- translate DSpace native
metadata into an external XML format.
This interface describes a plugin that produces metadata in an XML-based
format from the state of a DSpace object. Note that the object
may be an Item, Bitstream, Community, or Collection, although most
implementations only work on one type of object.
author:
Larry Stone
version:
$Revision: 2108 $ |
| Field Summary | |
| final static Namespace | XSI_NS
|
| Method Summary | |
| public boolean | canDisseminate(DSpaceObject dso)
Predicate: Can this disseminator crosswalk the given object.
Needed by OAI-PMH server implementation.
Parameters:
dso - dspace object, e.g. | | public Element | disseminateElement(DSpaceObject dso)
Execute crosswalk, returning one XML root element as
a JDOM Element object.
This is typically the root element of a document.
Parameters:
dso - the DSpace Object whose metadata to export. | | public List | disseminateList(DSpaceObject dso)
Execute crosswalk, returning List of XML elements.
Returns a List of JDOM Element objects representing
the XML produced by the crosswalk. | | public Namespace[] | getNamespaces()
Get XML namespaces of the elements this crosswalk may return. | | public String | getSchemaLocation()
Get the XML Schema location(s) of the target metadata format. | | public boolean | preferList()
Predicate: Does this disseminator prefer to return a list of Elements,
rather than a single root Element?
Some metadata formats have an XML schema without a root element,
for example, the Dublin Core and Qualified Dublin Core formats.
This would be true for a crosswalk into QDC, since
it would "prefer" to return a list, since any root element it has
to produce would have to be part of a nonstandard schema. |
| XSI_NS | | final static Namespace XSI_NS(Code) | | XSI namespace, required for xsi:schemalocation attributes
|
| canDisseminate | | public boolean canDisseminate(DSpaceObject dso)(Code) | | Predicate: Can this disseminator crosswalk the given object.
Needed by OAI-PMH server implementation.
Parameters:
dso - dspace object, e.g. an Item. true when disseminator is capable of producing metadata. |
| disseminateList | | public List disseminateList(DSpaceObject dso) throws CrosswalkException, IOException, SQLException, AuthorizeException(Code) | | Execute crosswalk, returning List of XML elements.
Returns a List of JDOM Element objects representing
the XML produced by the crosswalk. This is typically called when
a list of fields is desired, e.g. for embedding in a METS document
xmlData field.
When there are no results, an
empty list is returned, but never null.
Parameters:
dso - the DSpace Object whose metadata to export. results of crosswalk as list of XML elements.
throws:
CrosswalkInternalException - (CrosswalkException) failure of the crosswalk itself.
throws:
CrosswalkObjectNotSupported - (CrosswalkException) Cannot crosswalk this kind of DSpace object.
throws:
IOException - I/O failure in services this calls
throws:
SQLException - Database failure in services this calls
throws:
AuthorizeException - current user not authorized for this operation. |
| getNamespaces | | public Namespace[] getNamespaces()(Code) | | Get XML namespaces of the elements this crosswalk may return.
Returns the XML namespaces (as JDOM objects) of the root element.
array of namespaces, which may be empty. |
| getSchemaLocation | | public String getSchemaLocation()(Code) | | Get the XML Schema location(s) of the target metadata format.
Returns the string value of the xsi:schemaLocation
attribute that should be applied to the generated XML.
It may return the empty string if no schema is known, but crosswalk
authors are strongly encouraged to implement this call so their output
XML can be validated correctly.
SchemaLocation string, including URI namespace, followed bywhitespace and URI of XML schema document, or empty string if unknown. |
| preferList | | public boolean preferList()(Code) | | Predicate: Does this disseminator prefer to return a list of Elements,
rather than a single root Element?
Some metadata formats have an XML schema without a root element,
for example, the Dublin Core and Qualified Dublin Core formats.
This would be true for a crosswalk into QDC, since
it would "prefer" to return a list, since any root element it has
to produce would have to be part of a nonstandard schema. In
most cases your implementation will want to return
false
true when disseminator prefers you call disseminateList(). |
|
|