com.marklogic.client.alerting

Class RuleDefinition

java.lang.Object

com.marklogic.client.impl.HandleImplementation<R,W>

com.marklogic.client.io.BaseHandle<InputStream,OutputStreamSender>

com.marklogic.client.alerting.RuleDefinition

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, RuleReadHandle, RuleWriteHandle, OutputStreamSender

public class RuleDefinition
extends BaseHandle<InputStream,OutputStreamSender>
implements OutputStreamSender, RuleReadHandle, RuleWriteHandle

A RuleDefinition represents a set of criteria that describe a named condition.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RuleDefinition.RuleMetadata A RuleMetadata represents optional client-supplied metadata that is stored alongside a RuleDefinition.

Field Summary

Fields inherited from interface com.marklogic.client.document.ContentDescriptor

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
RuleDefinition() Make a new rule definition, no argument constructor.
RuleDefinition(String name, String description) Make a new rule definition

Method Summary

Modifier and Type	Method and Description
<T extends XMLReadHandle> T	exportQueryDefinition(T handle) Exports the embedded query definitions and options to a handle
String	getDescription() Returns the rule's definition.
RuleDefinition.RuleMetadata	getMetadata() Gets the metadata object associated with this rule
String	getName() Gets the name of the rule.
void	importQueryDefinition(XMLWriteHandle queryDef) Imports an XML combined search definition that defines the matching criteria for this rule.
void	setDescription(String description) Sets the description of the rule.
void	setMetadata(RuleDefinition.RuleMetadata metadata) Sets the metadata object for this rule.
void	setName(String name) Sets the name of the rule.
void	write(OutputStream out) Writes a serialized RuleDefinition to an OutputStream as XML.

Methods inherited from class com.marklogic.client.io.BaseHandle

getByteLength, getFormat, getMimetype, setByteLength, setFormat, setMimetype

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RuleDefinition

public RuleDefinition(String name,
                      String description)

Make a new rule definition

Parameters:

name - The name of the rule. Should be unique among rule names on the REST server.

description - Text description of the rule.

RuleDefinition

public RuleDefinition()

Make a new rule definition, no argument constructor.

Method Detail

setName

public void setName(String name)

Sets the name of the rule.

Parameters:

name - The rule's name.

getName

public String getName()

Gets the name of the rule.

Returns:

The rule's name.

setDescription

public void setDescription(String description)

Sets the description of the rule.

Parameters:

description - The rule's description.

getDescription

public String getDescription()

Returns the rule's definition.

Returns:

The definition.

importQueryDefinition

public void importQueryDefinition(XMLWriteHandle queryDef)

Imports an XML combined search definition that defines the matching criteria for this rule.

Parameters:

queryDef - A combined raw query definition serialized as XML.

exportQueryDefinition

public <T extends XMLReadHandle> T exportQueryDefinition(T handle)

Exports the embedded query definitions and options to a handle

Type Parameters:

T - the type of XMLReadHandle to return

Parameters:

handle - The handle to use for export.

Returns:

The handle, with a combined query and options included as XML.

getMetadata

public RuleDefinition.RuleMetadata getMetadata()

Gets the metadata object associated with this rule

Returns:

The metadata.

setMetadata

public void setMetadata(RuleDefinition.RuleMetadata metadata)

Sets the metadata object for this rule.

Parameters:

metadata - The metadata

write

public void write(OutputStream out)
           throws IOException

Writes a serialized RuleDefinition to an OutputStream as XML.

Specified by:

write in interface OutputStreamSender

Parameters:

out - the output stream receiving the content

Throws:

IOException - if io problems arise