com.bazaarvoice.jolt.common.pathelement

Class StarRegexPathElement

java.lang.Object

com.bazaarvoice.jolt.common.pathelement.BasePathElement

com.bazaarvoice.jolt.common.pathelement.StarRegexPathElement

All Implemented Interfaces:

MatchablePathElement, PathElement, StarPathElement

public class StarRegexPathElement
extends BasePathElement
implements StarPathElement

Non-greedy * based Path Element.

Constructor Summary

Constructors

Constructor and Description
StarRegexPathElement(String key)

Method Summary

Methods

Modifier and Type	Method and Description
String	getCanonicalForm() Get the canonical form of this PathElement.
LiteralPathElement	match(String dataKey, WalkedPath walkedPath) See if this PathElement matches the given dataKey.
boolean	stringMatch(String literal) Method to see if a candidate key would match this PathElement.

Methods inherited from class com.bazaarvoice.jolt.common.pathelement.BasePathElement

getRawKey, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bazaarvoice.jolt.common.pathelement.PathElement

getRawKey

Constructor Detail

StarRegexPathElement

public StarRegexPathElement(String key)

Method Detail

stringMatch

public boolean stringMatch(String literal)

Description copied from interface: StarPathElement

Method to see if a candidate key would match this PathElement.

Specified by:

stringMatch in interface StarPathElement

Parameters:

literal - test to see if the provided string will match this Element's regex

Returns:

true if the provided literal will match this Element's regex

match

public LiteralPathElement match(String dataKey,
                       WalkedPath walkedPath)

Description copied from interface: MatchablePathElement

See if this PathElement matches the given dataKey. If it does not match, this method returns null. If this PathElement does match, it returns a LiteralPathElement with subKeys filled in.

Specified by:

match in interface MatchablePathElement

Parameters:

dataKey - String key value from the input data

walkedPath - "up the tree" list of LiteralPathElements, that may be used by this key as it is computing its match

Returns:

null or a matched LiteralPathElement

getCanonicalForm

public String getCanonicalForm()

Description copied from interface: PathElement

Get the canonical form of this PathElement. Really only interesting for the Reference Path element, where it will expand "&" to "&0(0)".

Specified by:

getCanonicalForm in interface PathElement

Returns:

canonical String version of this PathElement