org.exist.collections.triggers
Class Dumper

java.lang.Object
  extended byorg.exist.collections.triggers.FilteringTrigger
      extended byorg.exist.collections.triggers.Dumper
All Implemented Interfaces:
org.xml.sax.ContentHandler, DocumentTrigger, org.xml.sax.ext.LexicalHandler, Trigger

public class Dumper
extends FilteringTrigger

Author:
wolf

Field Summary
 
Fields inherited from interface org.exist.collections.triggers.Trigger
CREATE_COLLECTION_EVENT, DELETE_COLLECTION_EVENT, REMOVE_DOCUMENT_EVENT, RENAME_COLLECTION_EVENT, STORE_DOCUMENT_EVENT, UPDATE_DOCUMENT_EVENT
 
Constructor Summary
Dumper()
           
 
Method Summary
 void configure(DBBroker broker, Collection parent, java.util.Map parameters)
          Configure the trigger.
 void finish(int event, DBBroker broker, Txn transaction, DocumentImpl document)
          This method is called after the operation completed.
 void prepare(int event, DBBroker broker, Txn transaction, XmldbURI documentName, DocumentImpl existingDocument)
          This method is called once before the database will actually parse the input data.
 
Methods inherited from class org.exist.collections.triggers.FilteringTrigger
characters, comment, endCDATA, endDocument, endDTD, endElement, endEntity, endPrefixMapping, getCollection, getInputHandler, getLexicalInputHandler, getLexicalOutputHandler, getLogger, getOutputHandler, ignorableWhitespace, isValidating, processingInstruction, setDocumentLocator, setLexicalOutputHandler, setOutputHandler, setValidating, skippedEntity, startCDATA, startDocument, startDTD, startElement, startEntity, startPrefixMapping
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Dumper

public Dumper()
Method Detail

configure

public void configure(DBBroker broker,
                      Collection parent,
                      java.util.Map parameters)
               throws CollectionConfigurationException
Description copied from class: FilteringTrigger
Configure the trigger. The default implementation just stores the parent collection reference into the field collection. Use method getCollection to later retrieve the collection.

Specified by:
configure in interface Trigger
Overrides:
configure in class FilteringTrigger
Throws:
CollectionConfigurationException

prepare

public void prepare(int event,
                    DBBroker broker,
                    Txn transaction,
                    XmldbURI documentName,
                    DocumentImpl existingDocument)
             throws TriggerException
Description copied from interface: DocumentTrigger
This method is called once before the database will actually parse the input data. You may take any action here, using the supplied broker instance.

Parameters:
event - the type of event that triggered this call (see the constants defined in this interface). The ContentHandler instance for the output.
broker - the database instance used to process the current action.
transaction - the current transaction context
documentName - the full absolute path of the document currently processed.
existingDocument - optional: if event is a Trigger.UPDATE_DOCUMENT_EVENT, existingDocument will contain the Document object for the old document, which will be overwritten. Otherwise, the parameter is null.
Throws:
TriggerException - throwing a TriggerException will abort the current action.

finish

public void finish(int event,
                   DBBroker broker,
                   Txn transaction,
                   DocumentImpl document)
Description copied from interface: DocumentTrigger
This method is called after the operation completed. At this point, the document has already been stored.

Specified by:
finish in interface DocumentTrigger
Overrides:
finish in class FilteringTrigger


Copyright (C) Wolfgang Meier. All rights reserved.