com.exalead.indexing.analysis.v10

Class XpathExtractor

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.XpathExtractor

All Implemented Interfaces:

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

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

Extraction is performed for the following data types:

• text/html. HTML Files.
• application/xml. XML Files.

Warning: To put before the NativeTextExtractor because the 'bytes' of each Document Binary Part are deleted by the NativeTextExtractor.
Limitations: This extractor handles node set and string functions. Not number and boolean. You can use number or boolean functions inside your xpath //img[starts-with(@src, "http://")] because this xpath return a set of nodes () but xpath count(//img) doesn't work because it returns a number.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XpathExtractor.HtmlParserToUse

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_HTML_PARSER_TO_USE
java.lang.String	htmlParserToUse
java.util.List<XpathRule>	xpathRule

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
XpathExtractor()
XpathExtractor(XpathExtractor 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 XpathExtractor.
static XpathExtractor	fromString(java.lang.String s) String representation of this XpathExtractor.
java.lang.String	getHtmlParserToUse() HTML parser to use in priority.
XpathExtractor.HtmlParserToUse	getHtmlParserToUseAsEnum() HTML parser to use in priority.
java.util.List<XpathRule>	getXpathRule()
static boolean	isA(java.lang.String str, XpathExtractor.HtmlParserToUse item)
static boolean	isOneOf(java.lang.String str, XpathExtractor.HtmlParserToUse... items)
XpathExtractor	makeCopy() Creates and returns a deep copy of this XpathExtractor.
static XpathExtractor	readFrom(java.io.InputStream is) Read this XpathExtractor from an XML fragment.
void	setHtmlParserToUse(java.lang.String htmlParserToUse) HTML parser to use in priority.
void	setHtmlParserToUse(XpathExtractor.HtmlParserToUse item) HTML parser to use in priority.
java.lang.String	toString() String representation of this XpathExtractor.
XpathExtractor	withAcceptCondition(AcceptCondition acceptCondition)
XpathExtractor	withDataModelClass(java.lang.String dataModelClass)
XpathExtractor	withDataModelProperty(java.lang.String dataModelProperty)
XpathExtractor	withDataModelState(java.lang.String dataModelState)
XpathExtractor	withDisabled(boolean disabled)
XpathExtractor	withDisabled(java.lang.Boolean disabled)
XpathExtractor	withFromDataModel(DocumentProcessor fromDataModel)
XpathExtractor	withHtmlParserToUse(java.lang.String htmlParserToUse)
XpathExtractor	withName(java.lang.String name)
XpathExtractor	withXpathRule(java.util.Collection<XpathRule> __values)
XpathExtractor	withXpathRule(XpathRule... __values)
void	writeTo(java.io.OutputStream os) Write this XpathExtractor 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

htmlParserToUse

public java.lang.String htmlParserToUse

DEFAULT_HTML_PARSER_TO_USE

public static final java.lang.String DEFAULT_HTML_PARSER_TO_USE

See Also:

Constant Field Values

xpathRule

public java.util.List<XpathRule> xpathRule

Constructor Detail

XpathExtractor

public XpathExtractor()

XpathExtractor

public XpathExtractor(XpathExtractor o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          XpathExtractor.HtmlParserToUse item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              XpathExtractor.HtmlParserToUse... items)

setHtmlParserToUse

public void setHtmlParserToUse(XpathExtractor.HtmlParserToUse item)

HTML parser to use in priority.

getHtmlParserToUseAsEnum

public XpathExtractor.HtmlParserToUse getHtmlParserToUseAsEnum()

HTML parser to use in priority.

withAcceptCondition

public XpathExtractor withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class DocumentProcessor

withName

public XpathExtractor withName(java.lang.String name)

Overrides:

withName in class DocumentProcessor

withDataModelState

public XpathExtractor withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class DocumentProcessor

withFromDataModel

public XpathExtractor withFromDataModel(DocumentProcessor fromDataModel)

withDataModelClass

public XpathExtractor withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class DocumentProcessor

withDataModelProperty

public XpathExtractor withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class DocumentProcessor

withDisabled

public XpathExtractor withDisabled(boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

withDisabled

public XpathExtractor withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class DocumentProcessor

setHtmlParserToUse

public void setHtmlParserToUse(java.lang.String htmlParserToUse)

HTML parser to use in priority.

getHtmlParserToUse

public java.lang.String getHtmlParserToUse()

HTML parser to use in priority.

withHtmlParserToUse

public XpathExtractor withHtmlParserToUse(java.lang.String htmlParserToUse)

getXpathRule

public java.util.List<XpathRule> getXpathRule()

withXpathRule

public XpathExtractor withXpathRule(XpathRule... __values)

withXpathRule

public XpathExtractor withXpathRule(java.util.Collection<XpathRule> __values)

makeCopy

public XpathExtractor makeCopy()

Creates and returns a deep copy of this XpathExtractor.

Overrides:

makeCopy in class DocumentProcessor

readFrom

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

Read this XpathExtractor 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 XpathExtractor as an XML fragment

Overrides:

writeTo in class DocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this XpathExtractor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this XpathExtractor.

Overrides:

toString in class DocumentProcessor

check

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

Checks this XpathExtractor.

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