com.exalead.mercury.mami.crawl.v21

Class Rules

java.lang.Object

com.exalead.mercury.mami.crawl.v21.Rules

All Implemented Interfaces:

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

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

A rule set identified by a key.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_GROUP
java.lang.String	group
java.lang.String	key
java.util.List<Rule>	rule

Constructor Summary

Constructors

Constructor and Description
Rules()
Rules(Rules o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this Rules.
Rules	clone() Creates and returns a deep copy of this Rules.
static Rules	fromString(java.lang.String s) String representation of this Rules.
java.lang.String	getGroup() Key used to group rules and root urls.
java.lang.String	getKey() How to interpret these rules. auto, adminui: place index/follow/accept rules where relevant, automatically. may break complex rules depending on other key-values pre, post, link, papi: place in preprocessor, postprocessor, linksfilter or papi filter only.
java.util.List<Rule>	getRule()
Rules	makeCopy() Creates and returns a deep copy of this Rules.
static Rules	readFrom(java.io.InputStream is) Read this Rules from an XML fragment.
void	setGroup(java.lang.String group) Key used to group rules and root urls.
void	setKey(java.lang.String key) How to interpret these rules. auto, adminui: place index/follow/accept rules where relevant, automatically. may break complex rules depending on other key-values pre, post, link, papi: place in preprocessor, postprocessor, linksfilter or papi filter only.
java.lang.String	toString() String representation of this Rules.
Rules	withGroup(java.lang.String group)
Rules	withKey(java.lang.String key)
Rules	withRule(java.util.Collection<Rule> __values)
Rules	withRule(Rule... __values)
void	writeTo(java.io.OutputStream os) Write this Rules as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

rule

public java.util.List<Rule> rule

key

public java.lang.String key

group

public java.lang.String group

DEFAULT_GROUP

public static final java.lang.String DEFAULT_GROUP

See Also:

Constant Field Values

Constructor Detail

Rules

public Rules()

Rules

public Rules(Rules o)

Copy constructor

Method Detail

getRule

public java.util.List<Rule> getRule()

withRule

public Rules withRule(Rule... __values)

withRule

public Rules withRule(java.util.Collection<Rule> __values)

setKey

public void setKey(java.lang.String key)

How to interpret these rules.
auto, adminui: place index/follow/accept rules where relevant, automatically.
may break complex rules depending on other key-values
pre, post, link, papi: place in preprocessor, postprocessor, linksfilter or papi filter only.

getKey

public java.lang.String getKey()

How to interpret these rules.
auto, adminui: place index/follow/accept rules where relevant, automatically.
may break complex rules depending on other key-values
pre, post, link, papi: place in preprocessor, postprocessor, linksfilter or papi filter only.

withKey

public Rules withKey(java.lang.String key)

setGroup

public void setGroup(java.lang.String group)

Key used to group rules and root urls.

getGroup

public java.lang.String getGroup()

Key used to group rules and root urls.

withGroup

public Rules withGroup(java.lang.String group)

clone

public Rules clone()

Creates and returns a deep copy of this Rules.

Overrides:

clone in class java.lang.Object

makeCopy

public Rules makeCopy()

Creates and returns a deep copy of this Rules.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this Rules.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this Rules.

Overrides:

toString in class java.lang.Object

check

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

Checks this Rules.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException