public class PatternsExpansionConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable
Modifier and Type | Class and Description |
---|---|
static class |
PatternsExpansionConfig.ErrorAction |
static class |
PatternsExpansionConfig.ErrorReportMode |
static class |
PatternsExpansionConfig.RejectedPatternAction |
static class |
PatternsExpansionConfig.RejectedPatternReportMode |
Modifier and Type | Field and Description |
---|---|
boolean |
allLanguages |
static boolean |
DEFAULT_ALL_LANGUAGES |
static java.lang.String |
DEFAULT_ERROR_ACTION |
static java.lang.String |
DEFAULT_ERROR_REPORT_MODE |
static int |
DEFAULT_MIN_PREFIX_SIZE |
static int |
DEFAULT_MIN_SUFFIX_SIZE |
static boolean |
DEFAULT_PERFORM_REGEXP_EXPANSION |
static java.lang.String |
DEFAULT_REJECTED_PATTERN_ACTION |
static java.lang.String |
DEFAULT_REJECTED_PATTERN_REPORT_MODE |
java.lang.String |
errorAction |
java.lang.String |
errorReportMode |
long |
expansionTimeout |
int |
minPrefixSize |
int |
minSuffixSize |
boolean |
performRegexpExpansion |
java.lang.String |
rejectedPatternAction |
java.lang.String |
rejectedPatternReportMode |
Constructor and Description |
---|
PatternsExpansionConfig() |
PatternsExpansionConfig(PatternsExpansionConfig o)
Copy constructor
|
Modifier and Type | Method and Description |
---|---|
void |
check(boolean deep,
java.lang.String errorContext)
Checks this PatternsExpansionConfig.
|
static PatternsExpansionConfig |
fromString(java.lang.String s)
String representation of this PatternsExpansionConfig.
|
java.lang.String |
getErrorAction()
Action to take when expansion fails:
normalize: Transforms the pattern into a simple string match.
remove: Removes the pattern from the query.
error: Returns an error.
|
PatternsExpansionConfig.ErrorAction |
getErrorActionAsEnum()
Action to take when expansion fails:
normalize: Transforms the pattern into a simple string match.
remove: Removes the pattern from the query.
error: Returns an error.
|
java.lang.String |
getErrorReportMode()
Specifies how to report an expansion error in 'Troubleshooting > Logs':
quiet: No log.
local: Error is reported in the Process log.
global: Error is reported in both Process and Global logs.
|
PatternsExpansionConfig.ErrorReportMode |
getErrorReportModeAsEnum()
Specifies how to report an expansion error in 'Troubleshooting > Logs':
quiet: No log.
local: Error is reported in the Process log.
global: Error is reported in both Process and Global logs.
|
long |
getExpansionTimeout()
Query expansion timeout for each pattern.
|
int |
getMinPrefixSize()
Minimum number of characters required before wilcard (*) for pattern expansion to be carried out.
|
int |
getMinSuffixSize()
Minimum number of characters required after wilcard (*) for pattern expansion to be carried out.
|
java.lang.String |
getRejectedPatternAction()
Action to perform when a pattern is rejected (because
the prefix or suffix is too short, or the regular expression is disabled):
normalize: Transforms the pattern into a simple string match.
remove: Removes the pattern from the query.
error: Returns an error.
|
PatternsExpansionConfig.RejectedPatternAction |
getRejectedPatternActionAsEnum()
Action to perform when a pattern is rejected (because
the prefix or suffix is too short, or the regular expression is disabled):
normalize: Transforms the pattern into a simple string match.
remove: Removes the pattern from the query.
error: Returns an error.
|
java.lang.String |
getRejectedPatternReportMode()
Specifies how to report a rejected pattern error in 'Troubleshooting > Logs':
quiet: No log.
local: Error is reported in the Process log.
global: Error is reported in both Process and Global logs.
|
PatternsExpansionConfig.RejectedPatternReportMode |
getRejectedPatternReportModeAsEnum()
Specifies how to report a rejected pattern error in 'Troubleshooting > Logs':
quiet: No log.
local: Error is reported in the Process log.
global: Error is reported in both Process and Global logs.
|
static boolean |
isA(java.lang.String str,
PatternsExpansionConfig.ErrorAction item) |
static boolean |
isA(java.lang.String str,
PatternsExpansionConfig.ErrorReportMode item) |
static boolean |
isA(java.lang.String str,
PatternsExpansionConfig.RejectedPatternAction item) |
static boolean |
isA(java.lang.String str,
PatternsExpansionConfig.RejectedPatternReportMode item) |
boolean |
isAllLanguages()
Performs query expansion on all languages, whatever the language of the orignal query.
|
static boolean |
isOneOf(java.lang.String str,
PatternsExpansionConfig.ErrorAction... items) |
static boolean |
isOneOf(java.lang.String str,
PatternsExpansionConfig.ErrorReportMode... items) |
static boolean |
isOneOf(java.lang.String str,
PatternsExpansionConfig.RejectedPatternAction... items) |
static boolean |
isOneOf(java.lang.String str,
PatternsExpansionConfig.RejectedPatternReportMode... items) |
boolean |
isPerformRegexpExpansion()
Allows query expansion on regular expressions.
|
PatternsExpansionConfig |
makeCopy()
Creates and returns a deep copy of this PatternsExpansionConfig.
|
static PatternsExpansionConfig |
readFrom(java.io.InputStream is)
Read this PatternsExpansionConfig from an XML fragment.
|
void |
setAllLanguages(boolean allLanguages)
Performs query expansion on all languages, whatever the language of the orignal query.
|
void |
setErrorAction(PatternsExpansionConfig.ErrorAction item)
Action to take when expansion fails:
normalize: Transforms the pattern into a simple string match.
remove: Removes the pattern from the query.
error: Returns an error.
|
void |
setErrorAction(java.lang.String errorAction)
Action to take when expansion fails:
normalize: Transforms the pattern into a simple string match.
remove: Removes the pattern from the query.
error: Returns an error.
|
void |
setErrorReportMode(PatternsExpansionConfig.ErrorReportMode item)
Specifies how to report an expansion error in 'Troubleshooting > Logs':
quiet: No log.
local: Error is reported in the Process log.
global: Error is reported in both Process and Global logs.
|
void |
setErrorReportMode(java.lang.String errorReportMode)
Specifies how to report an expansion error in 'Troubleshooting > Logs':
quiet: No log.
local: Error is reported in the Process log.
global: Error is reported in both Process and Global logs.
|
void |
setExpansionTimeout(long expansionTimeout)
Query expansion timeout for each pattern.
|
void |
setMinPrefixSize(int minPrefixSize)
Minimum number of characters required before wilcard (*) for pattern expansion to be carried out.
|
void |
setMinSuffixSize(int minSuffixSize)
Minimum number of characters required after wilcard (*) for pattern expansion to be carried out.
|
void |
setPerformRegexpExpansion(boolean performRegexpExpansion)
Allows query expansion on regular expressions.
|
void |
setRejectedPatternAction(PatternsExpansionConfig.RejectedPatternAction item)
Action to perform when a pattern is rejected (because
the prefix or suffix is too short, or the regular expression is disabled):
normalize: Transforms the pattern into a simple string match.
remove: Removes the pattern from the query.
error: Returns an error.
|
void |
setRejectedPatternAction(java.lang.String rejectedPatternAction)
Action to perform when a pattern is rejected (because
the prefix or suffix is too short, or the regular expression is disabled):
normalize: Transforms the pattern into a simple string match.
remove: Removes the pattern from the query.
error: Returns an error.
|
void |
setRejectedPatternReportMode(PatternsExpansionConfig.RejectedPatternReportMode item)
Specifies how to report a rejected pattern error in 'Troubleshooting > Logs':
quiet: No log.
local: Error is reported in the Process log.
global: Error is reported in both Process and Global logs.
|
void |
setRejectedPatternReportMode(java.lang.String rejectedPatternReportMode)
Specifies how to report a rejected pattern error in 'Troubleshooting > Logs':
quiet: No log.
local: Error is reported in the Process log.
global: Error is reported in both Process and Global logs.
|
java.lang.String |
toString()
String representation of this PatternsExpansionConfig.
|
PatternsExpansionConfig |
withAllLanguages(boolean allLanguages) |
PatternsExpansionConfig |
withAllLanguages(java.lang.Boolean allLanguages) |
PatternsExpansionConfig |
withErrorAction(java.lang.String errorAction) |
PatternsExpansionConfig |
withErrorReportMode(java.lang.String errorReportMode) |
PatternsExpansionConfig |
withExpansionTimeout(long expansionTimeout) |
PatternsExpansionConfig |
withExpansionTimeout(java.lang.Long expansionTimeout) |
PatternsExpansionConfig |
withMinPrefixSize(int minPrefixSize) |
PatternsExpansionConfig |
withMinPrefixSize(java.lang.Integer minPrefixSize) |
PatternsExpansionConfig |
withMinSuffixSize(int minSuffixSize) |
PatternsExpansionConfig |
withMinSuffixSize(java.lang.Integer minSuffixSize) |
PatternsExpansionConfig |
withPerformRegexpExpansion(boolean performRegexpExpansion) |
PatternsExpansionConfig |
withPerformRegexpExpansion(java.lang.Boolean performRegexpExpansion) |
PatternsExpansionConfig |
withRejectedPatternAction(java.lang.String rejectedPatternAction) |
PatternsExpansionConfig |
withRejectedPatternReportMode(java.lang.String rejectedPatternReportMode) |
void |
writeTo(java.io.OutputStream os)
Write this PatternsExpansionConfig as an XML fragment
|
public boolean performRegexpExpansion
public static final boolean DEFAULT_PERFORM_REGEXP_EXPANSION
public int minPrefixSize
public static final int DEFAULT_MIN_PREFIX_SIZE
public int minSuffixSize
public static final int DEFAULT_MIN_SUFFIX_SIZE
public long expansionTimeout
public boolean allLanguages
public static final boolean DEFAULT_ALL_LANGUAGES
public java.lang.String rejectedPatternAction
public static final java.lang.String DEFAULT_REJECTED_PATTERN_ACTION
public java.lang.String rejectedPatternReportMode
public static final java.lang.String DEFAULT_REJECTED_PATTERN_REPORT_MODE
public java.lang.String errorAction
public static final java.lang.String DEFAULT_ERROR_ACTION
public java.lang.String errorReportMode
public static final java.lang.String DEFAULT_ERROR_REPORT_MODE
public PatternsExpansionConfig()
public PatternsExpansionConfig(PatternsExpansionConfig o)
public static boolean isA(java.lang.String str, PatternsExpansionConfig.RejectedPatternAction item)
public static boolean isOneOf(java.lang.String str, PatternsExpansionConfig.RejectedPatternAction... items)
public void setRejectedPatternAction(PatternsExpansionConfig.RejectedPatternAction item)
public PatternsExpansionConfig.RejectedPatternAction getRejectedPatternActionAsEnum()
public static boolean isA(java.lang.String str, PatternsExpansionConfig.RejectedPatternReportMode item)
public static boolean isOneOf(java.lang.String str, PatternsExpansionConfig.RejectedPatternReportMode... items)
public void setRejectedPatternReportMode(PatternsExpansionConfig.RejectedPatternReportMode item)
public PatternsExpansionConfig.RejectedPatternReportMode getRejectedPatternReportModeAsEnum()
public static boolean isA(java.lang.String str, PatternsExpansionConfig.ErrorAction item)
public static boolean isOneOf(java.lang.String str, PatternsExpansionConfig.ErrorAction... items)
public void setErrorAction(PatternsExpansionConfig.ErrorAction item)
public PatternsExpansionConfig.ErrorAction getErrorActionAsEnum()
public static boolean isA(java.lang.String str, PatternsExpansionConfig.ErrorReportMode item)
public static boolean isOneOf(java.lang.String str, PatternsExpansionConfig.ErrorReportMode... items)
public void setErrorReportMode(PatternsExpansionConfig.ErrorReportMode item)
public PatternsExpansionConfig.ErrorReportMode getErrorReportModeAsEnum()
public void setPerformRegexpExpansion(boolean performRegexpExpansion)
public boolean isPerformRegexpExpansion()
public PatternsExpansionConfig withPerformRegexpExpansion(boolean performRegexpExpansion)
public PatternsExpansionConfig withPerformRegexpExpansion(java.lang.Boolean performRegexpExpansion)
public void setMinPrefixSize(int minPrefixSize)
public int getMinPrefixSize()
public PatternsExpansionConfig withMinPrefixSize(int minPrefixSize)
public PatternsExpansionConfig withMinPrefixSize(java.lang.Integer minPrefixSize)
public void setMinSuffixSize(int minSuffixSize)
public int getMinSuffixSize()
public PatternsExpansionConfig withMinSuffixSize(int minSuffixSize)
public PatternsExpansionConfig withMinSuffixSize(java.lang.Integer minSuffixSize)
public void setExpansionTimeout(long expansionTimeout)
public long getExpansionTimeout()
public PatternsExpansionConfig withExpansionTimeout(long expansionTimeout)
public PatternsExpansionConfig withExpansionTimeout(java.lang.Long expansionTimeout)
public void setAllLanguages(boolean allLanguages)
public boolean isAllLanguages()
public PatternsExpansionConfig withAllLanguages(boolean allLanguages)
public PatternsExpansionConfig withAllLanguages(java.lang.Boolean allLanguages)
public void setRejectedPatternAction(java.lang.String rejectedPatternAction)
public java.lang.String getRejectedPatternAction()
public PatternsExpansionConfig withRejectedPatternAction(java.lang.String rejectedPatternAction)
public void setRejectedPatternReportMode(java.lang.String rejectedPatternReportMode)
public java.lang.String getRejectedPatternReportMode()
public PatternsExpansionConfig withRejectedPatternReportMode(java.lang.String rejectedPatternReportMode)
public void setErrorAction(java.lang.String errorAction)
public java.lang.String getErrorAction()
public PatternsExpansionConfig withErrorAction(java.lang.String errorAction)
public void setErrorReportMode(java.lang.String errorReportMode)
public java.lang.String getErrorReportMode()
public PatternsExpansionConfig withErrorReportMode(java.lang.String errorReportMode)
public PatternsExpansionConfig makeCopy()
public static PatternsExpansionConfig readFrom(java.io.InputStream is) throws javax.xml.bind.JAXBException
javax.xml.bind.JAXBException
public void writeTo(java.io.OutputStream os) throws javax.xml.bind.JAXBException, java.io.IOException
javax.xml.bind.JAXBException
java.io.IOException
public static PatternsExpansionConfig fromString(java.lang.String s) throws javax.xml.bind.JAXBException, java.io.UnsupportedEncodingException
javax.xml.bind.JAXBException
java.io.UnsupportedEncodingException
public java.lang.String toString()
toString
in class java.lang.Object
public void check(boolean deep, java.lang.String errorContext) throws com.exalead.util.TypedException
check
in interface com.exalead.util.Checkable
com.exalead.util.TypedException
Copyright © 2013 Dassault Systèmes, All Rights Reserved.