com.exsoinn.util.epf

Class SelectionCriteria

java.lang.Object

com.exsoinn.util.epf.SelectionCriteria

@Immutable
public final class SelectionCriteria
extends Object

Encapsulates a all te information necessary to find data in a Context. You can build SelectionCriteria objects by passing a properly formatted String, and then invoking factory method valueOf(String). The format is a pipe delimited string with exacty 3 tokens, one each corresponding to, and in the same order, to a: SearchPath, Filter and TargetElements. Refer to each individual class for details on the format for each. Created by QuijadaJ on 5/18/2017.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEARCH_CRITERIA_DELIM
static String	SEARCH_CRITERIA_NULL

Method Summary

Modifier and Type	Method and Description
static SelectionCriteria	fromObjects(SearchPath pSearchPath, Filter pFilter, TargetElements pTargeElems)
Filter	getFilter()
SearchPath	getSearchPath()
TargetElements	getTargetElements()
String	specialCharactersConverted() Replaces special characters with string parse-friendly substitutes.
String	toString()
static SelectionCriteria	valueOf(String pStr)

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_CRITERIA_DELIM

public static final String SEARCH_CRITERIA_DELIM

See Also:

Constant Field Values

SEARCH_CRITERIA_NULL

public static final String SEARCH_CRITERIA_NULL

See Also:

Constant Field Values

Method Detail

valueOf

public static SelectionCriteria valueOf(String pStr)

fromObjects

public static SelectionCriteria fromObjects(SearchPath pSearchPath,
                                            Filter pFilter,
                                            TargetElements pTargeElems)

specialCharactersConverted

public String specialCharactersConverted()

Replaces special characters with string parse-friendly substitutes. By parse-friendly, it means removing characters that may have special meaning depending on who the consumer is, for example a regular expression engine, a JSON/XML parser, etc... These special characters if not escape or removed will error out when processed by some consumers. This convenience method attempts to take care of that conversion for you.

Returns:

- SelectionCriteria string with special characters converted to some string substitute.

getSearchPath

public SearchPath getSearchPath()

getTargetElements

public TargetElements getTargetElements()

getFilter

public Filter getFilter()

toString

public String toString()

Overrides:

toString in class Object