com.exalead.indexing.analysis.v10

Class XpathFragmentExtractor

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.XpathFragmentExtractor

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class XpathFragmentExtractor
extends DocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

Input: All DocumentChunks associated with the specified 'inputContext' ContextNames. Input can be XML or HTML fragment.
Output: DocumentChunks are created for each Xpath Fragment Rule. Each DocumentChunk is associated with the specified 'Meta name' ContextName.
Warning: To put before the NativeTextExtractor because the 'bytes' of each Document Binary Part are deleted by the NativeTextExtractor.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XpathFragmentExtractor.ParserToUse

Nested classes/interfaces inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

DocumentProcessor.FromDataModel, DocumentProcessor.Transformer<T>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_PARSER_TO_USE
java.lang.String	inputFragmentMeta
java.lang.String	parserToUse
java.util.List<XpathFragmentRule>	xpathFragmentRule

Fields inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

acceptCondition, dataModelClass, dataModelProperty, dataModelState, DEFAULT_DISABLED, disabled, fromDataModel, name

Constructor Summary

Constructors

Constructor and Description
XpathFragmentExtractor()
XpathFragmentExtractor(XpathFragmentExtractor o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this XpathFragmentExtractor.
static XpathFragmentExtractor	fromString(java.lang.String s) String representation of this XpathFragmentExtractor.
java.lang.String	getInputFragmentMeta()
java.lang.String	getParserToUse() Parser to use in priority.
XpathFragmentExtractor.ParserToUse	getParserToUseAsEnum() Parser to use in priority.
java.util.List<XpathFragmentRule>	getXpathFragmentRule()
static boolean	isA(java.lang.String str, XpathFragmentExtractor.ParserToUse item)
static boolean	isOneOf(java.lang.String str, XpathFragmentExtractor.ParserToUse... items)
XpathFragmentExtractor	makeCopy() Creates and returns a deep copy of this XpathFragmentExtractor.
static XpathFragmentExtractor	readFrom(java.io.InputStream is) Read this XpathFragmentExtractor from an XML fragment.
void	setInputFragmentMeta(java.lang.String inputFragmentMeta)
void	setParserToUse(java.lang.String parserToUse) Parser to use in priority.
void	setParserToUse(XpathFragmentExtractor.ParserToUse item) Parser to use in priority.
java.lang.String	toString() String representation of this XpathFragmentExtractor.
XpathFragmentExtractor	withAcceptCondition(AcceptCondition acceptCondition)
XpathFragmentExtractor	withDataModelClass(java.lang.String dataModelClass)
XpathFragmentExtractor	withDataModelProperty(java.lang.String dataModelProperty)
XpathFragmentExtractor	withDataModelState(java.lang.String dataModelState)
XpathFragmentExtractor	withDisabled(boolean disabled)
XpathFragmentExtractor	withDisabled(java.lang.Boolean disabled)
XpathFragmentExtractor	withFromDataModel(DocumentProcessor fromDataModel)
XpathFragmentExtractor	withInputFragmentMeta(java.lang.String inputFragmentMeta)
XpathFragmentExtractor	withName(java.lang.String name)
XpathFragmentExtractor	withParserToUse(java.lang.String parserToUse)
XpathFragmentExtractor	withXpathFragmentRule(java.util.Collection<XpathFragmentRule> __values)
XpathFragmentExtractor	withXpathFragmentRule(XpathFragmentRule... __values)
void	writeTo(java.io.OutputStream os) Write this XpathFragmentExtractor as an XML fragment

Methods inherited from class com.exalead.indexing.analysis.v10.DocumentProcessor

getAcceptCondition, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, isDisabled, setAcceptCondition, setDataModelClass, setDataModelProperty, setDataModelState, setDisabled, setFromDataModel, setName

Methods inherited from class java.lang.Object

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

Field Detail

inputFragmentMeta

public java.lang.String inputFragmentMeta

parserToUse

public java.lang.String parserToUse

DEFAULT_PARSER_TO_USE

public static final java.lang.String DEFAULT_PARSER_TO_USE

See Also:

Constant Field Values

xpathFragmentRule

public java.util.List<XpathFragmentRule> xpathFragmentRule

Constructor Detail

XpathFragmentExtractor

public XpathFragmentExtractor()

XpathFragmentExtractor

public XpathFragmentExtractor(XpathFragmentExtractor o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          XpathFragmentExtractor.ParserToUse item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              XpathFragmentExtractor.ParserToUse... items)

setParserToUse

public void setParserToUse(XpathFragmentExtractor.ParserToUse item)

Parser to use in priority.

getParserToUseAsEnum

public XpathFragmentExtractor.ParserToUse getParserToUseAsEnum()

Parser to use in priority.

withAcceptCondition

public XpathFragmentExtractor withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class DocumentProcessor

withName

public XpathFragmentExtractor withName(java.lang.String name)

Overrides:

withName in class DocumentProcessor

withDataModelState

public XpathFragmentExtractor withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class DocumentProcessor

withFromDataModel

public XpathFragmentExtractor withFromDataModel(DocumentProcessor fromDataModel)

withDataModelClass

public XpathFragmentExtractor withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class DocumentProcessor

withDataModelProperty

public XpathFragmentExtractor withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class DocumentProcessor

withDisabled

public XpathFragmentExtractor withDisabled(boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

withDisabled

public XpathFragmentExtractor withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

setInputFragmentMeta

public void setInputFragmentMeta(java.lang.String inputFragmentMeta)

getInputFragmentMeta

public java.lang.String getInputFragmentMeta()

withInputFragmentMeta

public XpathFragmentExtractor withInputFragmentMeta(java.lang.String inputFragmentMeta)

setParserToUse

public void setParserToUse(java.lang.String parserToUse)

Parser to use in priority.

getParserToUse

public java.lang.String getParserToUse()

Parser to use in priority.

withParserToUse

public XpathFragmentExtractor withParserToUse(java.lang.String parserToUse)

getXpathFragmentRule

public java.util.List<XpathFragmentRule> getXpathFragmentRule()

withXpathFragmentRule

public XpathFragmentExtractor withXpathFragmentRule(XpathFragmentRule... __values)

withXpathFragmentRule

public XpathFragmentExtractor withXpathFragmentRule(java.util.Collection<XpathFragmentRule> __values)

makeCopy

public XpathFragmentExtractor makeCopy()

Creates and returns a deep copy of this XpathFragmentExtractor.

Overrides:

makeCopy in class DocumentProcessor

readFrom

public static XpathFragmentExtractor readFrom(java.io.InputStream is)
                                       throws javax.xml.bind.JAXBException

Read this XpathFragmentExtractor from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this XpathFragmentExtractor as an XML fragment

Overrides:

writeTo in class DocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static XpathFragmentExtractor fromString(java.lang.String s)
                                         throws javax.xml.bind.JAXBException,
                                                java.io.UnsupportedEncodingException

String representation of this XpathFragmentExtractor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this XpathFragmentExtractor.

Overrides:

toString in class DocumentProcessor

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this XpathFragmentExtractor.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class DocumentProcessor

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(DocumentProcessor.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class DocumentProcessor

Throws:

com.exalead.util.TypedException