Package org.smooks.api.delivery
Interface Filter
-
- All Superinterfaces:
AutoCloseable
,Closeable
- All Known Implementing Classes:
AbstractFilter
,SaxNgFilter
,SmooksDOMFilter
public interface Filter extends Closeable
-
-
Field Summary
Fields Modifier and Type Field Description static String
CLOSE_EMPTY_ELEMENTS
static String
CLOSE_RESULT
static String
CLOSE_SOURCE
static String
DEFAULT_SERIALIZATION_ON
static String
ENTITIES_REWRITE
static String
MAINTAIN_ELEMENT_STACK
static String
MAX_NODE_DEPTH
static String
READER_POOL_SIZE
static String
REVERSE_VISIT_ORDER_ON_VISIT_AFTER
static String
STREAM_FILTER_TYPE
Stream filter type config parameter.static String
TERMINATE_ON_VISITOR_EXCEPTION
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
doFilter()
-
-
-
Field Detail
-
STREAM_FILTER_TYPE
static final String STREAM_FILTER_TYPE
Stream filter type config parameter.- See Also:
- Constant Field Values
-
CLOSE_SOURCE
static final String CLOSE_SOURCE
- See Also:
- Constant Field Values
-
CLOSE_RESULT
static final String CLOSE_RESULT
- See Also:
- Constant Field Values
-
ENTITIES_REWRITE
static final String ENTITIES_REWRITE
- See Also:
- Constant Field Values
-
CLOSE_EMPTY_ELEMENTS
static final String CLOSE_EMPTY_ELEMENTS
- See Also:
- Constant Field Values
-
DEFAULT_SERIALIZATION_ON
static final String DEFAULT_SERIALIZATION_ON
- See Also:
- Constant Field Values
-
MAINTAIN_ELEMENT_STACK
static final String MAINTAIN_ELEMENT_STACK
- See Also:
- Constant Field Values
-
MAX_NODE_DEPTH
static final String MAX_NODE_DEPTH
- See Also:
- Constant Field Values
-
REVERSE_VISIT_ORDER_ON_VISIT_AFTER
static final String REVERSE_VISIT_ORDER_ON_VISIT_AFTER
- See Also:
- Constant Field Values
-
TERMINATE_ON_VISITOR_EXCEPTION
static final String TERMINATE_ON_VISITOR_EXCEPTION
- See Also:
- Constant Field Values
-
READER_POOL_SIZE
static final String READER_POOL_SIZE
- See Also:
- Constant Field Values
-
-
Method Detail
-
doFilter
void doFilter() throws SmooksException
Filter the content in the suppliedSource
instance, outputing the result to the suppliedResult
instance. Implementations use static methods on theFilterSource
andFilterResult
classes to access theSource
andResults
objects.- Throws:
SmooksException
- Failed to filter.
-
-