com.exalead.mercury.mami.crawl.v20

Class Feed

java.lang.Object

com.exalead.mercury.mami.crawl.v20.IRoot

com.exalead.mercury.mami.crawl.v20.Feed

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Feed
extends IRoot
implements java.io.Serializable, java.lang.Cloneable

A feed. Contains KeyValue* that are mapped to metas on all documents crawled from this root. Beware: there is a 4KB limit on the whole url + metas storage.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	findFeeds
protected java.lang.Boolean	findMediaLinks
protected java.lang.Boolean	forceFeedMimeType
protected java.lang.Boolean	indexFeedItems
protected java.lang.Boolean	indexItemDocuments
protected java.util.List<KeyValue>	keyValue
protected java.lang.Integer	refreshPeriodS

Fields inherited from class com.exalead.mercury.mami.crawl.v20.IRoot

group, priority, site, url

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Feed	clone() Creates and returns a deep copy of this object.
java.util.List<KeyValue>	getKeyValue() Gets the value of the keyValue property.
int	getRefreshPeriodS() how often to refresh this feed, default 10min (default: 600)
boolean	isFindFeeds() whether to crawl feeds found in html headers (default: false)
boolean	isFindMediaLinks() find and youtube/dailymotion links in item text and push them as metas (default: true)
boolean	isForceFeedMimeType() can't work with findFeeds enabled.
boolean	isIndexFeedItems() whether to index all items found in the feed with metas, before crawling them (default: true)
boolean	isIndexItemDocuments() whether to crawl the items and index the full item pages (default: true)
void	setFindFeeds(java.lang.Boolean value) Sets the value of the findFeeds property.
void	setFindMediaLinks(java.lang.Boolean value) Sets the value of the findMediaLinks property.
void	setForceFeedMimeType(java.lang.Boolean value) Sets the value of the forceFeedMimeType property.
void	setIndexFeedItems(java.lang.Boolean value) Sets the value of the indexFeedItems property.
void	setIndexItemDocuments(java.lang.Boolean value) Sets the value of the indexItemDocuments property.
void	setRefreshPeriodS(java.lang.Integer value) Sets the value of the refreshPeriodS property.
Feed	withFindFeeds(java.lang.Boolean value)
Feed	withFindMediaLinks(java.lang.Boolean value)
Feed	withForceFeedMimeType(java.lang.Boolean value)
Feed	withGroup(java.lang.String value)
Feed	withIndexFeedItems(java.lang.Boolean value)
Feed	withIndexItemDocuments(java.lang.Boolean value)
Feed	withKeyValue(java.util.Collection<KeyValue> values)
Feed	withKeyValue(KeyValue... values)
Feed	withPriority(java.lang.Integer value)
Feed	withRefreshPeriodS(java.lang.Integer value)
Feed	withSite(java.lang.Boolean value)
Feed	withUrl(java.lang.String value)

Methods inherited from class com.exalead.mercury.mami.crawl.v20.IRoot

getGroup, getPriority, getUrl, isSite, setGroup, setPriority, setSite, setUrl

Methods inherited from class java.lang.Object

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

Field Detail

keyValue

protected java.util.List<KeyValue> keyValue

refreshPeriodS

protected java.lang.Integer refreshPeriodS

indexFeedItems

protected java.lang.Boolean indexFeedItems

indexItemDocuments

protected java.lang.Boolean indexItemDocuments

findFeeds

protected java.lang.Boolean findFeeds

forceFeedMimeType

protected java.lang.Boolean forceFeedMimeType

findMediaLinks

protected java.lang.Boolean findMediaLinks

Constructor Detail

Feed

public Feed()

Creates a new Feed instance.

Feed

public Feed(Feed o)

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

Parameters:

o - The instance to copy.

Throws:

java.lang.NullPointerException - if o is null.

Method Detail

getKeyValue

public java.util.List<KeyValue> getKeyValue()

Gets the value of the keyValue 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 keyValue property.

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

    getKeyValue().add(newItem);
 

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

getRefreshPeriodS

public int getRefreshPeriodS()

how often to refresh this feed, default 10min (default: 600)

Returns:

possible object is Integer

setRefreshPeriodS

public void setRefreshPeriodS(java.lang.Integer value)

Sets the value of the refreshPeriodS property.

Parameters:

value - allowed object is Integer

isIndexFeedItems

public boolean isIndexFeedItems()

whether to index all items found in the feed with metas, before crawling them (default: true)

Returns:

possible object is Boolean

setIndexFeedItems

public void setIndexFeedItems(java.lang.Boolean value)

Sets the value of the indexFeedItems property.

Parameters:

value - allowed object is Boolean

isIndexItemDocuments

public boolean isIndexItemDocuments()

whether to crawl the items and index the full item pages (default: true)

Returns:

possible object is Boolean

setIndexItemDocuments

public void setIndexItemDocuments(java.lang.Boolean value)

Sets the value of the indexItemDocuments property.

Parameters:

value - allowed object is Boolean

isFindFeeds

public boolean isFindFeeds()

whether to crawl feeds found in html headers (default: false)

Returns:

possible object is Boolean

setFindFeeds

public void setFindFeeds(java.lang.Boolean value)

Sets the value of the findFeeds property.

Parameters:

value - allowed object is Boolean

isForceFeedMimeType

public boolean isForceFeedMimeType()

can't work with findFeeds enabled. (default: false)

Returns:

possible object is Boolean

setForceFeedMimeType

public void setForceFeedMimeType(java.lang.Boolean value)

Sets the value of the forceFeedMimeType property.

Parameters:

value - allowed object is Boolean

isFindMediaLinks

public boolean isFindMediaLinks()

find and youtube/dailymotion links in item text and push them as metas (default: true)

Returns:

possible object is Boolean

setFindMediaLinks

public void setFindMediaLinks(java.lang.Boolean value)

Sets the value of the findMediaLinks property.

Parameters:

value - allowed object is Boolean

withKeyValue

public Feed withKeyValue(KeyValue... values)

withKeyValue

public Feed withKeyValue(java.util.Collection<KeyValue> values)

withRefreshPeriodS

public Feed withRefreshPeriodS(java.lang.Integer value)

withIndexFeedItems

public Feed withIndexFeedItems(java.lang.Boolean value)

withIndexItemDocuments

public Feed withIndexItemDocuments(java.lang.Boolean value)

withFindFeeds

public Feed withFindFeeds(java.lang.Boolean value)

withForceFeedMimeType

public Feed withForceFeedMimeType(java.lang.Boolean value)

withFindMediaLinks

public Feed withFindMediaLinks(java.lang.Boolean value)

withUrl

public Feed withUrl(java.lang.String value)

Overrides:

withUrl in class IRoot

withSite

public Feed withSite(java.lang.Boolean value)

Overrides:

withSite in class IRoot

withPriority

public Feed withPriority(java.lang.Integer value)

Overrides:

withPriority in class IRoot

withGroup

public Feed withGroup(java.lang.String value)

Overrides:

withGroup in class IRoot

clone

public Feed clone()

Creates and returns a deep copy of this object.

Overrides:

clone in class IRoot

Returns:

A deep copy of this object.