com.exalead.indexing.analysis.v10

Class URLCodec

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

com.exalead.indexing.analysis.v10.URLCodec

All Implemented Interfaces:

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

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

URL encode/decode with UTF-8 charset only

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	URLCodec.Mode

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 boolean	DEFAULT_ENCODE_U_R_I_COMPONENT
static java.lang.String	DEFAULT_MODE
boolean	encodeURIComponent
java.lang.String	mode
java.lang.String	outputContext

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
URLCodec()
URLCodec(URLCodec 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 URLCodec.
static URLCodec	fromString(java.lang.String s) String representation of this URLCodec.
java.lang.String	getMode() mode = "encode" or "decode"
URLCodec.Mode	getModeAsEnum() mode = "encode" or "decode"
java.lang.String	getOutputContext() Stores URL encoded form in outputContext. If outputContext = inputContext, it removes the original chunk.
static boolean	isA(java.lang.String str, URLCodec.Mode item)
boolean	isEncodeURIComponent() If true (default), it encodes the following characters: ',' '/' '?' ':' '@' '&' '=' '+' '$' '#'
static boolean	isOneOf(java.lang.String str, URLCodec.Mode... items)
URLCodec	makeCopy() Creates and returns a deep copy of this URLCodec.
static URLCodec	readFrom(java.io.InputStream is) Read this URLCodec from an XML fragment.
void	setEncodeURIComponent(boolean encodeURIComponent) If true (default), it encodes the following characters: ',' '/' '?' ':' '@' '&' '=' '+' '$' '#'
void	setMode(java.lang.String mode) mode = "encode" or "decode"
void	setMode(URLCodec.Mode item) mode = "encode" or "decode"
void	setOutputContext(java.lang.String outputContext) Stores URL encoded form in outputContext. If outputContext = inputContext, it removes the original chunk.
java.lang.String	toString() String representation of this URLCodec.
URLCodec	withAcceptCondition(AcceptCondition acceptCondition)
URLCodec	withDataModelClass(java.lang.String dataModelClass)
URLCodec	withDataModelProperty(java.lang.String dataModelProperty)
URLCodec	withDataModelState(java.lang.String dataModelState)
URLCodec	withDisabled(boolean disabled)
URLCodec	withDisabled(java.lang.Boolean disabled)
URLCodec	withEncodeURIComponent(boolean encodeURIComponent)
URLCodec	withEncodeURIComponent(java.lang.Boolean encodeURIComponent)
URLCodec	withFromDataModel(DocumentProcessor fromDataModel)
URLCodec	withInputContext(java.lang.String inputContext)
URLCodec	withMode(java.lang.String mode)
URLCodec	withName(java.lang.String name)
URLCodec	withOutputContext(java.lang.String outputContext)
void	writeTo(java.io.OutputStream os) Write this URLCodec 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

outputContext

public java.lang.String outputContext

encodeURIComponent

public boolean encodeURIComponent

DEFAULT_ENCODE_U_R_I_COMPONENT

public static final boolean DEFAULT_ENCODE_U_R_I_COMPONENT

See Also:

Constant Field Values

mode

public java.lang.String mode

DEFAULT_MODE

public static final java.lang.String DEFAULT_MODE

See Also:

Constant Field Values

Constructor Detail

URLCodec

public URLCodec()

URLCodec

public URLCodec(URLCodec o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          URLCodec.Mode item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              URLCodec.Mode... items)

setMode

public void setMode(URLCodec.Mode item)

mode = "encode" or "decode"

getModeAsEnum

public URLCodec.Mode getModeAsEnum()

mode = "encode" or "decode"

withInputContext

public URLCodec withInputContext(java.lang.String inputContext)

Overrides:

withInputContext in class SingleContextDocumentProcessor

withAcceptCondition

public URLCodec withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class SingleContextDocumentProcessor

withName

public URLCodec withName(java.lang.String name)

Overrides:

withName in class SingleContextDocumentProcessor

withDataModelState

public URLCodec withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SingleContextDocumentProcessor

withFromDataModel

public URLCodec withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class SingleContextDocumentProcessor

withDataModelClass

public URLCodec withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SingleContextDocumentProcessor

withDataModelProperty

public URLCodec withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SingleContextDocumentProcessor

withDisabled

public URLCodec withDisabled(boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

withDisabled

public URLCodec withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

setOutputContext

public void setOutputContext(java.lang.String outputContext)

Stores URL encoded form in outputContext.
If outputContext = inputContext, it removes the original chunk.

getOutputContext

public java.lang.String getOutputContext()

Stores URL encoded form in outputContext.
If outputContext = inputContext, it removes the original chunk.

withOutputContext

public URLCodec withOutputContext(java.lang.String outputContext)

setEncodeURIComponent

public void setEncodeURIComponent(boolean encodeURIComponent)

If true (default), it encodes the following characters:
',' '/' '?' ':' '@' '&' '=' '+' '$' '#'

isEncodeURIComponent

public boolean isEncodeURIComponent()

If true (default), it encodes the following characters:
',' '/' '?' ':' '@' '&' '=' '+' '$' '#'

withEncodeURIComponent

public URLCodec withEncodeURIComponent(boolean encodeURIComponent)

withEncodeURIComponent

public URLCodec withEncodeURIComponent(java.lang.Boolean encodeURIComponent)

setMode

public void setMode(java.lang.String mode)

mode = "encode" or "decode"

getMode

public java.lang.String getMode()

mode = "encode" or "decode"

withMode

public URLCodec withMode(java.lang.String mode)

makeCopy

public URLCodec makeCopy()

Creates and returns a deep copy of this URLCodec.

Overrides:

makeCopy in class SingleContextDocumentProcessor

readFrom

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

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

Overrides:

writeTo in class SingleContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this URLCodec.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this URLCodec.

Overrides:

toString in class SingleContextDocumentProcessor

check

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

Checks this URLCodec.

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