com.exalead.indexing.analysis.v10

Class URLTransformer

java.lang.Object

com.exalead.indexing.analysis.v10.DocumentProcessor

com.exalead.indexing.analysis.v10.SingleContextDocumentProcessor

com.exalead.indexing.analysis.v10.URLTransformer

All Implemented Interfaces:

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

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

Parses a context string as a regular URL (RFC 2396, "Uniform Resource Identifier") and transforms it according to the given URL pattern.
A new DocumentChunk is created with the substitution.
Pattern used to transform the URL (in the form <scheme>://<authority><path>?<query>#<fragment>):

• Characters other than '$' or '\' are kept as-is
• The '$' character and the '\' character must be escaped with a leading \
• The ${expression} form allows to compute a string expression based on URL components (see "Expression" below)

Expression used inside the enclosing ${}:

• url: Original URL
• scheme: Scheme name ("http", "https", "file", ...)
• authority: Authority (host:port or host) (may be empty)
• host: Hostname part of the authority (may be empty)
• port: Port number part of the authority (may be empty)
• userInfo: username:password field of the authority (may be empty)
• file: File starting with / and query string, if any
• pathurl: Normalized absolute path starting with /
• path: Normalized absolute path (may start with C:\ on Windows)
• query: Normalized query part starting with ? (may be empty)
• args: Query part without the leading ? (may be empty)
• fragment: Fragment part starting with #(may be empty)
• reference: Reference part ; i.e., fragment without the leading # (may be empty)
• arg:name: Query part argument identified by its name, unescaped (you must re-escape it using "urlencode:" when necessary)
• str:string: The final argument is not a variable name, but a string (only useful for clarity purpose)
• tolower:expression: Transform into lowercase (ONLY A-Z)
• toupper:expression: Transform into uppercase (ONLY a-z)
• urlencode:expression :URL encoding (%NN or +)
• urlpathencode:expression: URL encoding outside / fragments
• urldecode:expression: URL decoding
• pathslash:expression: Convert \ into /
• pathantislash:expression: Convert / into \

Notes:

• Unreserved characters are unescaped during URL processing (i.e., never '%' or '\')
• The lower other similar prefix accept recursion (i.e., the expression "${urlpathencode:pathantislash:toupper:path}" is valid)
• Both "file://C:\path" and "file:///C:\path" will produce path="/C:\path"

Examples:

• With the input context value "http://www.example.com/bar/foo?bar=42"
  • "hello, world" => "hello, world"
  • "the scheme is ${scheme}" => "the scheme is http"
  • "the scheme is \${scheme}" => "the scheme is \${scheme}
  • "http://myserver${path}${query}" => "http://myserver/bar/foo?bar=42"
  • "http://myserver/applet?f=${urlpathencode:path}&t=${arg:bar}" => "http://myserver/applet?f=/bar/foo&t=42"
  • "http://myserver/applet?f=${urlencode:path}&t=${arg:bar}" => "http://myserver/applet?f=%2Fbar%2Ffoo&t=42"
  • "http://myserver/applet?f=${urlpathencode:pathantislash:toupper:path}" => "http://myserver/applet?f=%5CBAR%5CFOO"
• With the input context value "file:///C:/My%20Documents/Document.doc"
  • "${pathantislash:urldecode:path}" => "C:\My Documents\Document.doc"

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
java.lang.String	outputContext
java.lang.String	urlPattern

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
URLTransformer()
URLTransformer(URLTransformer 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 URLTransformer.
static URLTransformer	fromString(java.lang.String s) String representation of this URLTransformer.
java.lang.String	getOutputContext() ContextName to be associated with the DocumentChunk created for each new context.
java.lang.String	getUrlPattern() Pattern used to transform the URL.
URLTransformer	makeCopy() Creates and returns a deep copy of this URLTransformer.
static URLTransformer	readFrom(java.io.InputStream is) Read this URLTransformer from an XML fragment.
void	setOutputContext(java.lang.String outputContext) ContextName to be associated with the DocumentChunk created for each new context.
void	setUrlPattern(java.lang.String urlPattern) Pattern used to transform the URL.
java.lang.String	toString() String representation of this URLTransformer.
URLTransformer	withAcceptCondition(AcceptCondition acceptCondition)
URLTransformer	withDataModelClass(java.lang.String dataModelClass)
URLTransformer	withDataModelProperty(java.lang.String dataModelProperty)
URLTransformer	withDataModelState(java.lang.String dataModelState)
URLTransformer	withDisabled(boolean disabled)
URLTransformer	withDisabled(java.lang.Boolean disabled)
URLTransformer	withFromDataModel(DocumentProcessor fromDataModel)
URLTransformer	withInputContext(java.lang.String inputContext)
URLTransformer	withName(java.lang.String name)
URLTransformer	withOutputContext(java.lang.String outputContext)
URLTransformer	withUrlPattern(java.lang.String urlPattern)
void	writeTo(java.io.OutputStream os) Write this URLTransformer 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

urlPattern

public java.lang.String urlPattern

Constructor Detail

URLTransformer

public URLTransformer()

URLTransformer

public URLTransformer(URLTransformer o)

Copy constructor

Method Detail

withInputContext

public URLTransformer withInputContext(java.lang.String inputContext)

Overrides:

withInputContext in class SingleContextDocumentProcessor

withAcceptCondition

public URLTransformer withAcceptCondition(AcceptCondition acceptCondition)

Overrides:

withAcceptCondition in class SingleContextDocumentProcessor

withName

public URLTransformer withName(java.lang.String name)

Overrides:

withName in class SingleContextDocumentProcessor

withDataModelState

public URLTransformer withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class SingleContextDocumentProcessor

withFromDataModel

public URLTransformer withFromDataModel(DocumentProcessor fromDataModel)

Overrides:

withFromDataModel in class SingleContextDocumentProcessor

withDataModelClass

public URLTransformer withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class SingleContextDocumentProcessor

withDataModelProperty

public URLTransformer withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class SingleContextDocumentProcessor

withDisabled

public URLTransformer withDisabled(boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

withDisabled

public URLTransformer withDisabled(java.lang.Boolean disabled)

Overrides:

withDisabled in class SingleContextDocumentProcessor

setOutputContext

public void setOutputContext(java.lang.String outputContext)

ContextName to be associated with the DocumentChunk created for each new context.

getOutputContext

public java.lang.String getOutputContext()

ContextName to be associated with the DocumentChunk created for each new context.

withOutputContext

public URLTransformer withOutputContext(java.lang.String outputContext)

setUrlPattern

public void setUrlPattern(java.lang.String urlPattern)

Pattern used to transform the URL.

getUrlPattern

public java.lang.String getUrlPattern()

Pattern used to transform the URL.

withUrlPattern

public URLTransformer withUrlPattern(java.lang.String urlPattern)

makeCopy

public URLTransformer makeCopy()

Creates and returns a deep copy of this URLTransformer.

Overrides:

makeCopy in class SingleContextDocumentProcessor

readFrom

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

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

Overrides:

writeTo in class SingleContextDocumentProcessor

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this URLTransformer.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this URLTransformer.

Overrides:

toString in class SingleContextDocumentProcessor

check

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

Checks this URLTransformer.

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