com.exalead.mercury.mami.search.v20

Class RestrictedNode

java.lang.Object

com.exalead.mercury.mami.search.v20.RestrictedNode

All Implemented Interfaces:

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

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

Restrict occurences of a given node within a search query

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestrictedNode.Action
static class	RestrictedNode.Node

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	action
static java.lang.String	DEFAULT_ACTION
static int	DEFAULT_MAXIMUM_COUNT
int	maximumCount
java.lang.String	node

Constructor Summary

Constructors

Constructor and Description
RestrictedNode()
RestrictedNode(RestrictedNode o) Copy constructor
RestrictedNode(java.lang.String node, int maximumCount)
RestrictedNode(java.lang.String node, int maximumCount, java.lang.String action)

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this RestrictedNode.
static RestrictedNode	fromString(java.lang.String s) String representation of this RestrictedNode.
java.lang.String	getAction()
RestrictedNode.Action	getActionAsEnum()
int	getMaximumCount() Maximum number of occurences allowed for a given node.
java.lang.String	getNode()
RestrictedNode.Node	getNodeAsEnum()
static boolean	isA(java.lang.String str, RestrictedNode.Action item)
static boolean	isA(java.lang.String str, RestrictedNode.Node item)
static boolean	isOneOf(java.lang.String str, RestrictedNode.Action... items)
static boolean	isOneOf(java.lang.String str, RestrictedNode.Node... items)
RestrictedNode	makeCopy() Creates and returns a deep copy of this RestrictedNode.
static RestrictedNode	readFrom(java.io.InputStream is) Read this RestrictedNode from an XML fragment.
void	setAction(RestrictedNode.Action item)
void	setAction(java.lang.String action)
void	setMaximumCount(int maximumCount) Maximum number of occurences allowed for a given node.
void	setNode(RestrictedNode.Node item)
void	setNode(java.lang.String node)
java.lang.String	toString() String representation of this RestrictedNode.
RestrictedNode	withAction(java.lang.String action)
RestrictedNode	withMaximumCount(int maximumCount)
RestrictedNode	withMaximumCount(java.lang.Integer maximumCount)
RestrictedNode	withNode(java.lang.String node)
void	writeTo(java.io.OutputStream os) Write this RestrictedNode as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

node

public java.lang.String node

maximumCount

public int maximumCount

DEFAULT_MAXIMUM_COUNT

public static final int DEFAULT_MAXIMUM_COUNT

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

RestrictedNode

public RestrictedNode()

RestrictedNode

public RestrictedNode(java.lang.String node,
                      int maximumCount)

RestrictedNode

public RestrictedNode(java.lang.String node,
                      int maximumCount,
                      java.lang.String action)

RestrictedNode

public RestrictedNode(RestrictedNode o)

Copy constructor

Method Detail

isA

public static boolean isA(java.lang.String str,
                          RestrictedNode.Node item)

isOneOf

public static boolean isOneOf(java.lang.String str,
                              RestrictedNode.Node... items)

setNode

public void setNode(RestrictedNode.Node item)

getNodeAsEnum

public RestrictedNode.Node getNodeAsEnum()

isA

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

isOneOf

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

setAction

public void setAction(RestrictedNode.Action item)

getActionAsEnum

public RestrictedNode.Action getActionAsEnum()

setNode

public void setNode(java.lang.String node)

getNode

public java.lang.String getNode()

withNode

public RestrictedNode withNode(java.lang.String node)

setMaximumCount

public void setMaximumCount(int maximumCount)

Maximum number of occurences allowed for a given node.

getMaximumCount

public int getMaximumCount()

Maximum number of occurences allowed for a given node.

withMaximumCount

public RestrictedNode withMaximumCount(int maximumCount)

withMaximumCount

public RestrictedNode withMaximumCount(java.lang.Integer maximumCount)

setAction

public void setAction(java.lang.String action)

getAction

public java.lang.String getAction()

withAction

public RestrictedNode withAction(java.lang.String action)

makeCopy

public RestrictedNode makeCopy()

Creates and returns a deep copy of this RestrictedNode.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this RestrictedNode.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this RestrictedNode.

Overrides:

toString in class java.lang.Object

check

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

Checks this RestrictedNode.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException