com.exalead.mercury.mami.crawl.v20

Class Rules

java.lang.Object

com.exalead.mercury.mami.crawl.v20.Rules

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Rules
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

A rule set identified by a key.

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
Rules() Creates a new Rules instance.
Rules(Rules o) Creates a new Rules instance by deeply copying a given Rules instance.

Method Summary

Modifier and Type	Method and Description
Rules	clone() Creates and returns a deep copy of this object.
java.lang.String	getGroup() Key used to group rules and root urls.
java.lang.String	getKey() How to interpret these rules.
java.util.List<Rule>	getRule() Gets the value of the rule property.
void	setGroup(java.lang.String value) Sets the value of the group property.
void	setKey(java.lang.String value) Sets the value of the key property.
Rules	withGroup(java.lang.String value)
Rules	withKey(java.lang.String value)
Rules	withRule(java.util.Collection<Rule> values)
Rules	withRule(Rule... values)

Methods inherited from class java.lang.Object

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

Field Detail

rule

protected java.util.List<Rule> rule

key

protected java.lang.String key

group

protected java.lang.String group

Constructor Detail

Rules

public Rules()

Creates a new Rules instance.

Rules

public Rules(Rules o)

Creates a new Rules instance by deeply copying a given Rules instance.

Parameters:

o - The instance to copy.

Throws:

java.lang.NullPointerException - if o is null.

Method Detail

getRule

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

Gets the value of the rule property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the rule property.

For example, to add a new item, do as follows:

    getRule().add(newItem);
 

Objects of the following type(s) are allowed in the list Rule

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. (default: null)

Returns:

possible object is String

setKey

public void setKey(java.lang.String value)

Sets the value of the key property.

Parameters:

value - allowed object is String

getGroup

public java.lang.String getGroup()

Key used to group rules and root urls. (default: null)

Returns:

possible object is String

setGroup

public void setGroup(java.lang.String value)

Sets the value of the group property.

Parameters:

value - allowed object is String

withRule

public Rules withRule(Rule... values)

withRule

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

withKey

public Rules withKey(java.lang.String value)

withGroup

public Rules withGroup(java.lang.String value)

clone

public Rules clone()

Creates and returns a deep copy of this object.

Overrides:

clone in class java.lang.Object

Returns:

A deep copy of this object.