com.bazaarvoice.jolt.common.pathelement

Class LiteralPathElement

java.lang.Object

com.bazaarvoice.jolt.common.pathelement.BasePathElement

com.bazaarvoice.jolt.common.pathelement.LiteralPathElement

All Implemented Interfaces:

EvaluatablePathElement, MatchablePathElement, PathElement

public class LiteralPathElement
extends BasePathElement
implements MatchablePathElement, EvaluatablePathElement

Constructor Summary

Constructors

Constructor and Description
LiteralPathElement(String key)
LiteralPathElement(String key, List<String> subKeys)

Method Summary

Methods

Modifier and Type	Method and Description
String	evaluate(WalkedPath walkedPath) Evaluate this key as if it is an write path element.
String	getCanonicalForm() Get the canonical form of this PathElement.
int	getHashCount()
int	getSubKeyCount()
String	getSubKeyRef(int index)
void	incrementHashCount()
LiteralPathElement	match(String dataKey, WalkedPath walkedPath) See if this PathElement matches the given dataKey.

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

LiteralPathElement

public LiteralPathElement(String key)

LiteralPathElement

public LiteralPathElement(String key,
                  List<String> subKeys)

Method Detail

evaluate

public String evaluate(WalkedPath walkedPath)

Description copied from interface: EvaluatablePathElement

Evaluate this key as if it is an write path element.

Specified by:

evaluate in interface EvaluatablePathElement

Parameters:

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

Returns:

String path element to use for write tree building

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

getSubKeyRef

public String getSubKeyRef(int index)

getSubKeyCount

public int getSubKeyCount()

getHashCount

public int getHashCount()

incrementHashCount

public void incrementHashCount()