public class DescriptionOpenSearchGenerator
extends org.apache.cocoon.generation.AbstractGenerator
implements org.apache.cocoon.caching.CacheableProcessingComponent, org.apache.avalon.excalibur.pool.Recyclable
| Modifier and Type | Field and Description |
|---|---|
protected DSpaceObject |
scope
optional search scope (community or collection instance) or null
|
objectModel, parameters, resolver, source| Constructor and Description |
|---|
DescriptionOpenSearchGenerator() |
| Modifier and Type | Method and Description |
|---|---|
void |
generate()
Generate the OpenSearch description document
|
java.io.Serializable |
getKey()
Generate the unique caching key.
|
org.apache.excalibur.source.SourceValidity |
getValidity()
It's not expected that the OpenSearch's configuration to be changed very frecuently,
so we assume this component is always valid (the cache should be cleared to update this component)
|
void |
recycle()
Recycle
|
void |
setup(org.apache.cocoon.environment.SourceResolver resolver,
java.util.Map objectModel,
java.lang.String src,
org.apache.avalon.framework.parameters.Parameters par)
Setup configuration for this request.
|
setConsumer, setContentHandler, setLexicalHandlerprotected DSpaceObject scope
public java.io.Serializable getKey()
getKey in interface org.apache.cocoon.caching.CacheableProcessingComponentpublic org.apache.excalibur.source.SourceValidity getValidity()
getValidity in interface org.apache.cocoon.caching.CacheableProcessingComponentpublic void setup(org.apache.cocoon.environment.SourceResolver resolver,
java.util.Map objectModel,
java.lang.String src,
org.apache.avalon.framework.parameters.Parameters par)
throws org.apache.cocoon.ProcessingException,
org.xml.sax.SAXException,
java.io.IOException
setup in interface org.apache.cocoon.sitemap.SitemapModelComponentsetup in class org.apache.cocoon.generation.AbstractGeneratororg.apache.cocoon.ProcessingException - if the scope param cannot be resolved to a valid Community or Collectionorg.xml.sax.SAXExceptionjava.io.IOExceptionpublic void generate()
throws java.io.IOException,
org.xml.sax.SAXException,
org.apache.cocoon.ProcessingException
generate in interface org.apache.cocoon.generation.Generatorjava.io.IOExceptionorg.xml.sax.SAXExceptionorg.apache.cocoon.ProcessingExceptionpublic void recycle()
recycle in interface org.apache.avalon.excalibur.pool.Recyclablerecycle in class org.apache.cocoon.generation.AbstractGeneratorCopyright © 2018 DuraSpace. All Rights Reserved.