com.exalead.mercury.mami.search.v20

Class RestrictedOperator

java.lang.Object

com.exalead.mercury.mami.search.v20.RestrictedOperator

All Implemented Interfaces:

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

public class RestrictedOperator
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Restrict occurrences of a given operator within a search query

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestrictedOperator.Action
static class	RestrictedOperator.Operator

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	action
static java.lang.String	DEFAULT_ACTION
static int	DEFAULT_MAXIMUM_ARITY
int	maximumArity
java.lang.String	operator

Constructor Summary

Constructors

Constructor and Description
RestrictedOperator()
RestrictedOperator(RestrictedOperator o) Copy constructor
RestrictedOperator(java.lang.String operator, int maximumArity)
RestrictedOperator(java.lang.String operator, int maximumArity, java.lang.String action)

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this RestrictedOperator.
static RestrictedOperator	fromString(java.lang.String s) String representation of this RestrictedOperator.
java.lang.String	getAction()
RestrictedOperator.Action	getActionAsEnum()
int	getMaximumArity() Maximum number of children allowed for a given operator.
java.lang.String	getOperator()
RestrictedOperator.Operator	getOperatorAsEnum()
static boolean	isA(java.lang.String str, RestrictedOperator.Action item)
static boolean	isA(java.lang.String str, RestrictedOperator.Operator item)
static boolean	isOneOf(java.lang.String str, RestrictedOperator.Action... items)
static boolean	isOneOf(java.lang.String str, RestrictedOperator.Operator... items)
RestrictedOperator	makeCopy() Creates and returns a deep copy of this RestrictedOperator.
static RestrictedOperator	readFrom(java.io.InputStream is) Read this RestrictedOperator from an XML fragment.
void	setAction(RestrictedOperator.Action item)
void	setAction(java.lang.String action)
void	setMaximumArity(int maximumArity) Maximum number of children allowed for a given operator.
void	setOperator(RestrictedOperator.Operator item)
void	setOperator(java.lang.String operator)
java.lang.String	toString() String representation of this RestrictedOperator.
RestrictedOperator	withAction(java.lang.String action)
RestrictedOperator	withMaximumArity(int maximumArity)
RestrictedOperator	withMaximumArity(java.lang.Integer maximumArity)
RestrictedOperator	withOperator(java.lang.String operator)
void	writeTo(java.io.OutputStream os) Write this RestrictedOperator as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

operator

public java.lang.String operator

maximumArity

public int maximumArity

DEFAULT_MAXIMUM_ARITY

public static final int DEFAULT_MAXIMUM_ARITY

See Also:

Constant Field Values

action

public java.lang.String action

DEFAULT_ACTION

public static final java.lang.String DEFAULT_ACTION

See Also:

Constant Field Values

Constructor Detail

RestrictedOperator

public RestrictedOperator()

RestrictedOperator

public RestrictedOperator(java.lang.String operator,
                          int maximumArity)

RestrictedOperator

public RestrictedOperator(java.lang.String operator,
                          int maximumArity,
                          java.lang.String action)

RestrictedOperator

public RestrictedOperator(RestrictedOperator o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          RestrictedOperator.Operator item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              RestrictedOperator.Operator... items)

setOperator

public void setOperator(RestrictedOperator.Operator item)

getOperatorAsEnum

public RestrictedOperator.Operator getOperatorAsEnum()

isA

public static boolean isA(java.lang.String str,
                          RestrictedOperator.Action item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              RestrictedOperator.Action... items)

setAction

public void setAction(RestrictedOperator.Action item)

getActionAsEnum

public RestrictedOperator.Action getActionAsEnum()

setOperator

public void setOperator(java.lang.String operator)

getOperator

public java.lang.String getOperator()

withOperator

public RestrictedOperator withOperator(java.lang.String operator)

setMaximumArity

public void setMaximumArity(int maximumArity)

Maximum number of children allowed for a given operator.

getMaximumArity

public int getMaximumArity()

Maximum number of children allowed for a given operator.

withMaximumArity

public RestrictedOperator withMaximumArity(int maximumArity)

withMaximumArity

public RestrictedOperator withMaximumArity(java.lang.Integer maximumArity)

setAction

public void setAction(java.lang.String action)

getAction

public java.lang.String getAction()

withAction

public RestrictedOperator withAction(java.lang.String action)

makeCopy

public RestrictedOperator makeCopy()

Creates and returns a deep copy of this RestrictedOperator.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RestrictedOperator.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RestrictedOperator.

Overrides:

toString in class java.lang.Object

check

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

Checks this RestrictedOperator.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException