org.dspace.app.xmlui.aspect.general
Class ChoiceLookupTransformer

java.lang.Object
  org.apache.cocoon.util.AbstractLogEnabled
      org.apache.cocoon.xml.AbstractXMLProducer
          org.apache.cocoon.xml.AbstractXMLPipe
              org.apache.cocoon.transformation.AbstractTransformer
                  org.dspace.app.xmlui.wing.AbstractWingTransformer
                      org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer
                          org.dspace.app.xmlui.aspect.general.ChoiceLookupTransformer

All Implemented Interfaces:

org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.transformation.Transformer, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer, org.apache.excalibur.xml.sax.XMLConsumer, DSpaceTransformer, WingTransformer, ContentHandler, LexicalHandler

public class ChoiceLookupTransformer
extends AbstractDSpaceTransformer

Create the "lookup" popup window for Choice Control. It loads a selector via AJAX request, and transfers values (both text and authority/confidence) back to the indicated form fields in the window that launched it. Some necessary logic is in JavaScript, see choice-control.js. Expected Parameters: field - name of metadata field in "_" notation, eg: dc_contributor_author value - maybe-partial value of field formID - the @id of

tag in calling window containing the inputs we are to set. valueInput - @name of input field in DOM for value. authorityInput - @name of input field in DOM for authority value isRepeating - true if metadata value can be repeated isName - true if this is a name value (i.e. last/first boxes) start - starting index, default 0 limit - maximum values to return, default 0 (none) Configuration Properties: xmlui.lookup.select.size = 12 (default, entries to show in SELECT widget.) For each FIELD, e.g. dc.contributor.author, these message properties will OVERRIDE the corresponding i18n message catalog entries: xmlui.lookup.field.FIELD.title = title of lookup page (e.g. xmlui.lookup.field.dc_contributor_author.title = Author..) xmlui.lookup.field.FIELD.nonauthority = template for "non-authority" label in options xmlui.lookup.field.FIELD.help = help message for single input (NOTE this is still required even for name inputs) xmlui.lookup.field.FIELD.help.last = help message for last name of Name-oriented input xmlui.lookup.field.FIELD.help.first = help message for first name of Name-oriented input

Author:

Larry Stone

Field Summary

Fields inherited from class org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

context, contextPath, eperson, knot, objectModel, parameters, servletPath, sitemapURI, url

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.transformation.Transformer

ROLE

Constructor Summary

ChoiceLookupTransformer()

Method Summary

void	addBody(Body body) What to add at the end of the body
void	addPageMeta(PageMeta pageMeta) What page metadata to add to the document

Methods inherited from class org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

addOptions, addUserMeta, decodeFromURL, dispose, encodeForURL, generateURL, getComponentName, getObjectManager, handleException, recycle, setup

Methods inherited from class org.dspace.app.xmlui.wing.AbstractWingTransformer

createWingDocument, endDocument, endElement, endPrefixMapping, getDefaultMessageCatalogue, message, message, setupWing, startDocument, startElement, startPrefixMapping

Methods inherited from class org.apache.cocoon.xml.AbstractXMLPipe

characters, comment, endCDATA, endDTD, endEntity, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDTD, startEntity

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

characters, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity

Methods inherited from interface org.xml.sax.ext.LexicalHandler

comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Constructor Detail

ChoiceLookupTransformer

public ChoiceLookupTransformer()

Method Detail

addBody

public void addBody(Body body)
             throws SAXException,
                    WingException,
                    UIException,
                    SQLException,
                    IOException,
                    AuthorizeException

Description copied from class: AbstractDSpaceTransformer

What to add at the end of the body

Specified by:

addBody in interface DSpaceTransformer

Specified by:

addBody in interface WingTransformer

Overrides:

addBody in class AbstractDSpaceTransformer

Throws:

SAXException

WingException

UIException

SQLException

IOException

AuthorizeException

addPageMeta

public void addPageMeta(PageMeta pageMeta)
                 throws SAXException,
                        WingException,
                        UIException,
                        SQLException,
                        IOException,
                        AuthorizeException

Description copied from class: AbstractDSpaceTransformer

What page metadata to add to the document

Specified by:

addPageMeta in interface DSpaceTransformer

Specified by:

addPageMeta in interface WingTransformer

Overrides:

addPageMeta in class AbstractDSpaceTransformer

Throws:

SAXException

WingException

UIException

SQLException

IOException

AuthorizeException