org.xmlecho.palomar.xform
Interface ElementFilter

All Superinterfaces:
org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, Transformer, org.xml.sax.XMLFilter, org.xml.sax.XMLReader

public interface ElementFilter
extends Transformer

A streaming filter that selectively removes Elements from the input


Method Summary
 ElementTest createAndTest(ElementTest one, ElementTest two)
           
 ElementTest createAttrTestEQ(java.lang.String namespace, java.lang.String name, java.lang.String testval)
           
 ElementTest createAttrTestExist(java.lang.String namespace, java.lang.String name)
           
 ElementTest createAttrTestGE(java.lang.String namespace, java.lang.String name, java.lang.String testval)
           
 ElementTest createAttrTestGT(java.lang.String namespace, java.lang.String name, java.lang.String testval)
           
 ElementTest createAttrTestLE(java.lang.String namespace, java.lang.String name, java.lang.String testval)
           
 ElementTest createAttrTestLT(java.lang.String namespace, java.lang.String name, java.lang.String testval)
           
 ElementTest createAttrTestRegex(java.lang.String namespace, java.lang.String name, java.lang.String regex)
          Performs a test of the named attribute's value against the given regular expression
 ElementTest createElemCountTest(java.lang.String namespace, java.lang.String name, int skipCount, int passCount, int passDepth)
           
 ElementTest createElemNameTest(java.lang.String namespace, java.lang.String name)
           
 ElementTest createFalseTest()
          always tests false
 ElementTest createNotTest(ElementTest who)
          boolean negation of an element test
 ElementTest createOrTest(ElementTest one, ElementTest two)
           
 ElementTest createTrueTest()
          always tests true
 void setTester(ElementTest tester)
           
 
Methods inherited from interface org.xmlecho.palomar.xform.Transformer
setParams, setStylesheet
 
Methods inherited from interface org.xml.sax.XMLFilter
getParent, setParent
 
Methods inherited from interface org.xml.sax.XMLReader
getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getProperty, parse, parse, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setProperty
 
Methods inherited from interface org.xml.sax.EntityResolver
resolveEntity
 
Methods inherited from interface org.xml.sax.DTDHandler
notationDecl, unparsedEntityDecl
 
Methods inherited from interface org.xml.sax.ContentHandler
characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping
 
Methods inherited from interface org.xml.sax.ErrorHandler
error, fatalError, warning
 

Method Detail

setTester

public void setTester(ElementTest tester)

createNotTest

public ElementTest createNotTest(ElementTest who)
boolean negation of an element test


createFalseTest

public ElementTest createFalseTest()
always tests false


createTrueTest

public ElementTest createTrueTest()
always tests true


createAndTest

public ElementTest createAndTest(ElementTest one,
                                 ElementTest two)

createOrTest

public ElementTest createOrTest(ElementTest one,
                                ElementTest two)

createAttrTestExist

public ElementTest createAttrTestExist(java.lang.String namespace,
                                       java.lang.String name)
Parameters:
namespace - the attribute name's namespace
name - the attribute name's local name
Returns:
true if the attribute exists on an element

createAttrTestLT

public ElementTest createAttrTestLT(java.lang.String namespace,
                                    java.lang.String name,
                                    java.lang.String testval)
Parameters:
namespace - the attribute name's namespace
name - the attribute name's local name

createAttrTestGT

public ElementTest createAttrTestGT(java.lang.String namespace,
                                    java.lang.String name,
                                    java.lang.String testval)
Parameters:
namespace - the attribute name's namespace
name - the attribute name's local name

createAttrTestEQ

public ElementTest createAttrTestEQ(java.lang.String namespace,
                                    java.lang.String name,
                                    java.lang.String testval)
Parameters:
namespace - the attribute name's namespace
name - the attribute name's local name

createAttrTestLE

public ElementTest createAttrTestLE(java.lang.String namespace,
                                    java.lang.String name,
                                    java.lang.String testval)
Parameters:
namespace - the attribute name's namespace
name - the attribute name's local name

createAttrTestGE

public ElementTest createAttrTestGE(java.lang.String namespace,
                                    java.lang.String name,
                                    java.lang.String testval)
Parameters:
namespace - the attribute name's namespace
name - the attribute name's local name

createAttrTestRegex

public ElementTest createAttrTestRegex(java.lang.String namespace,
                                       java.lang.String name,
                                       java.lang.String regex)
Performs a test of the named attribute's value against the given regular expression

Parameters:
namespace - the attribute name's namespace
name - the attribute name's local name

createElemNameTest

public ElementTest createElemNameTest(java.lang.String namespace,
                                      java.lang.String name)
Parameters:
namespace - the attribute name's namespace
name - the attribute name's local name

createElemCountTest

public ElementTest createElemCountTest(java.lang.String namespace,
                                       java.lang.String name,
                                       int skipCount,
                                       int passCount,
                                       int passDepth)
Parameters:
namespace - the attribute name's namespace
name - the attribute name's local name
skipCount - number of elements to skip
passCount - number of elements to pass