com.exalead.indexing.analysis.v10

Class PublicUrlProcessor

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

com.exalead.indexing.analysis.v10.PublicUrlProcessor

All Implemented Interfaces:

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

public class PublicUrlProcessor
extends SingleContextDocumentProcessor
implements com.exalead.util.Checkable, java.io.Serializable

For each input DocumentChunk associated with the 'inputContext' ContextName, 4 DocumentChunks are created, each associated with a different ContextName:

• 'treeOutputContext'
• 'leafOutputContext'
• 'urlOutputContext'
• 'urlCategoryOutputContext'

See Also:

Serialized Form

Nested Class Summary

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

SingleContextDocumentProcessor.Transformer<T>

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

DocumentProcessor.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_PATH_DEPTH
java.lang.String	leafOutputContext
int	maxPathDepth
java.lang.String	treeOutputContext
java.lang.String	urlOutputContext
java.lang.String	urlPathOutputContext

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

inputContext

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
PublicUrlProcessor()
PublicUrlProcessor(PublicUrlProcessor o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(DocumentProcessor.Transformer<T> transformer, T[] t)
<T> T	accept(SingleContextDocumentProcessor.Transformer<T> transformer, T[] t)
void	check(boolean deep, java.lang.String errorContext) Checks this PublicUrlProcessor.
static PublicUrlProcessor	fromString(java.lang.String s) String representation of this PublicUrlProcessor.
java.lang.String	getLeafOutputContext() The ContextName for the DocumentChunks created from the complete, normalized, URL.
int	getMaxPathDepth() maximum depth of url path
java.lang.String	getTreeOutputContext() The ContextName for the DocumentChunk created from the category path encoding the web site tree.
java.lang.String	getUrlOutputContext() The ContextName for the DocumentChunk created from the complete, normalized URL.
java.lang.String	getUrlPathOutputContext() The ContextName for the DocumentChunk created from the normalized URL.
PublicUrlProcessor	makeCopy() Creates and returns a deep copy of this PublicUrlProcessor.
static PublicUrlProcessor	readFrom(java.io.InputStream is) Read this PublicUrlProcessor from an XML fragment.
void	setLeafOutputContext(java.lang.String leafOutputContext) The ContextName for the DocumentChunks created from the complete, normalized, URL.
void	setMaxPathDepth(int maxPathDepth) maximum depth of url path
void	setTreeOutputContext(java.lang.String treeOutputContext) The ContextName for the DocumentChunk created from the category path encoding the web site tree.
void	setUrlOutputContext(java.lang.String urlOutputContext) The ContextName for the DocumentChunk created from the complete, normalized URL.
void	setUrlPathOutputContext(java.lang.String urlPathOutputContext) The ContextName for the DocumentChunk created from the normalized URL.
java.lang.String	toString() String representation of this PublicUrlProcessor.
PublicUrlProcessor	withAcceptCondition(AcceptCondition acceptCondition)
PublicUrlProcessor	withDataModelClass(java.lang.String dataModelClass)
PublicUrlProcessor	withDataModelProperty(java.lang.String dataModelProperty)
PublicUrlProcessor	withDataModelState(java.lang.String dataModelState)
PublicUrlProcessor	withDisabled(boolean disabled)
PublicUrlProcessor	withDisabled(java.lang.Boolean disabled)
PublicUrlProcessor	withFromDataModel(DocumentProcessor fromDataModel)
PublicUrlProcessor	withInputContext(java.lang.String inputContext)
PublicUrlProcessor	withLeafOutputContext(java.lang.String leafOutputContext)
PublicUrlProcessor	withMaxPathDepth(int maxPathDepth)
PublicUrlProcessor	withMaxPathDepth(java.lang.Integer maxPathDepth)
PublicUrlProcessor	withName(java.lang.String name)
PublicUrlProcessor	withTreeOutputContext(java.lang.String treeOutputContext)
PublicUrlProcessor	withUrlOutputContext(java.lang.String urlOutputContext)
PublicUrlProcessor	withUrlPathOutputContext(java.lang.String urlPathOutputContext)
void	writeTo(java.io.OutputStream os) Write this PublicUrlProcessor as an XML fragment

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

getInputContext, setInputContext

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

treeOutputContext

public java.lang.String treeOutputContext

leafOutputContext

public java.lang.String leafOutputContext

urlOutputContext

public java.lang.String urlOutputContext

urlPathOutputContext

public java.lang.String urlPathOutputContext

maxPathDepth

public int maxPathDepth

DEFAULT_MAX_PATH_DEPTH

public static final int DEFAULT_MAX_PATH_DEPTH

See Also:

Constant Field Values

Constructor Detail

PublicUrlProcessor

public PublicUrlProcessor()

PublicUrlProcessor

public PublicUrlProcessor(PublicUrlProcessor o)

Copy constructor

Method Detail

withInputContext

public PublicUrlProcessor withInputContext(java.lang.String inputContext)

Overrides:

withInputContext in class SingleContextDocumentProcessor

withAcceptCondition

public PublicUrlProcessor withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class SingleContextDocumentProcessor

withName

public PublicUrlProcessor withName(java.lang.String name)

Overrides:

withName in class SingleContextDocumentProcessor

withDataModelState

public PublicUrlProcessor withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SingleContextDocumentProcessor

withFromDataModel

public PublicUrlProcessor withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class SingleContextDocumentProcessor

withDataModelClass

public PublicUrlProcessor withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SingleContextDocumentProcessor

withDataModelProperty

public PublicUrlProcessor withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SingleContextDocumentProcessor

withDisabled

public PublicUrlProcessor withDisabled(boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

withDisabled

public PublicUrlProcessor withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

setTreeOutputContext

public void setTreeOutputContext(java.lang.String treeOutputContext)

The ContextName for the DocumentChunk created from the category path encoding the web site tree.

getTreeOutputContext

public java.lang.String getTreeOutputContext()

The ContextName for the DocumentChunk created from the category path encoding the web site tree.

withTreeOutputContext

public PublicUrlProcessor withTreeOutputContext(java.lang.String treeOutputContext)

setLeafOutputContext

public void setLeafOutputContext(java.lang.String leafOutputContext)

The ContextName for the DocumentChunks created from the complete, normalized, URL.

getLeafOutputContext

public java.lang.String getLeafOutputContext()

The ContextName for the DocumentChunks created from the complete, normalized, URL.

withLeafOutputContext

public PublicUrlProcessor withLeafOutputContext(java.lang.String leafOutputContext)

setUrlOutputContext

public void setUrlOutputContext(java.lang.String urlOutputContext)

The ContextName for the DocumentChunk created from the complete, normalized URL.

getUrlOutputContext

public java.lang.String getUrlOutputContext()

The ContextName for the DocumentChunk created from the complete, normalized URL.

withUrlOutputContext

public PublicUrlProcessor withUrlOutputContext(java.lang.String urlOutputContext)

setUrlPathOutputContext

public void setUrlPathOutputContext(java.lang.String urlPathOutputContext)

The ContextName for the DocumentChunk created from the normalized URL.

getUrlPathOutputContext

public java.lang.String getUrlPathOutputContext()

The ContextName for the DocumentChunk created from the normalized URL.

withUrlPathOutputContext

public PublicUrlProcessor withUrlPathOutputContext(java.lang.String urlPathOutputContext)

setMaxPathDepth

public void setMaxPathDepth(int maxPathDepth)

maximum depth of url path

getMaxPathDepth

public int getMaxPathDepth()

maximum depth of url path

withMaxPathDepth

public PublicUrlProcessor withMaxPathDepth(int maxPathDepth)

withMaxPathDepth

public PublicUrlProcessor withMaxPathDepth(java.lang.Integer maxPathDepth)

makeCopy

public PublicUrlProcessor makeCopy()

Creates and returns a deep copy of this PublicUrlProcessor.

Overrides:

makeCopy in class SingleContextDocumentProcessor

readFrom

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

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

Overrides:

writeTo in class SingleContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this PublicUrlProcessor.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this PublicUrlProcessor.

Overrides:

toString in class SingleContextDocumentProcessor

check

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

Checks this PublicUrlProcessor.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class SingleContextDocumentProcessor

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class SingleContextDocumentProcessor

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