ResultFeed (NETVIBES Exalead CloudView Clients SDK)

java.lang.Object
- com.exalead.access.feedapi.utils.AccessLogLevelConfiguration
- - com.exalead.access.feedapi.eval.mel.extension.AbstractMELType
  - - com.exalead.access.feedapi.FacetsContainer
    - - com.exalead.access.feedapi.ResultFeed

All Implemented Interfaces:

com.exalead.access.feedapi.eval.mel.extension.HasMELFlags, com.exalead.access.feedapi.eval.mel.extension.MELType, com.exalead.access.feedapi.eval.mel.extension.MELTypeVisitor<com.exalead.access.feedapi.eval.mel.extension.MELType,com.exalead.access.feedapi.eval.mel.extension.MELType.ArithmeticOperation>, com.exalead.access.feedapi.eval.mel.extension.types.MELCollatable<com.exalead.access.feedapi.eval.mel.extension.MELType>, com.exalead.access.feedapi.eval.mel.extension.types.MELStore<Facet>, HasFacets, java.io.Serializable, java.lang.Cloneable
```
public class ResultFeed
extends FacetsContainer
implements HasFacets, java.lang.Cloneable, java.io.Serializable
```
ResultFeed contains query informations, entries, facets...

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ResultFeed.Field

static class ResultFeed.FieldsHolder
- Nested classes/interfaces inherited from interface com.exalead.access.feedapi.eval.mel.extension.MELType
  com.exalead.access.feedapi.eval.mel.extension.MELType.ArithmeticOperation, com.exalead.access.feedapi.eval.mel.extension.MELType.AttributePointer<P>

Nested Classes
Modifier and Type	Class and Description
`static class`	`ResultFeed.Field`
`static class`	`ResultFeed.FieldsHolder`

Field Summary
- Fields inherited from class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType
  flags

Constructor Summary

Constructors
Constructor and Description

ResultFeed(Feed feed)

ResultFeed(java.lang.String feedId, java.lang.String generatorClassName)

Constructors
Constructor and Description
`ResultFeed(Feed feed)`
`ResultFeed(java.lang.String feedId, java.lang.String generatorClassName)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addEntry(Entry entry)` Adds the given entry to this feed.
`void`	`addExtraSerializedObject(java.lang.String id, ExtraSerializedObject serializedObject)`
`void`	`addInfo(java.lang.String name, java.lang.String value)` Helper which add an information to the ResultFeed
`void`	`addSpellCheckSuggestion(SpellCheckSuggestion spellCheckSuggestion)`
`void`	`addSpellCheckSuggestion(java.lang.String spellCheckSuggestion)` Deprecated.
`void`	`addStat(java.lang.String name, java.lang.String value)` Helper which add an stat data to the ResultFeed
`java.util.Iterator<Category>`	`categoryIterator(java.lang.String root, CategoryTreeContainer.IterationMode mode)` Get a Category Iterator for the provided Category Root, using the provided IterationMode.
`java.lang.Object`	`clone()`
`java.lang.String`	`getActAsFeed()` Returns whether this feed should act as another feed (ie.
`java.lang.String`	`getContext()` Returns the context (eg: refines).
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getContextAsMap()` Returns the feed context as a Map.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getContextFullAsMap()` Returns the full feed context as a Map.
`int`	`getCurrentPage()` Returns the current page (uses getStartIndex() and getItemsPerPage())
`java.util.List<Entry>`	`getEntries()` Returns a list of entries
`java.lang.Exception`	`getError()` Returns the error exception
`java.util.HashMap<java.lang.String,ExtraSerializedObject>`	`getExtraSerializedObjects()` Returns extra objects that have been serialized
`java.lang.String`	`getFeedUri()` Returns the URI of the feed (useful for AJAX).
`com.exalead.access.feedapi.eval.mel.extension.AbstractMELType.FieldsHolder`	`getFields()`
`com.exalead.access.feedapi.eval.mel.extension.types.MELFlags`	`getFlags()`
`java.lang.String`	`getGenerator()` Returns the basefeed classname used to create this ResultFeed
`java.lang.String`	`getId()` Returns the feed identifier.
`java.util.Map<java.lang.String,java.lang.String>`	`getInfos()` Returns feed informations
`int`	`getItemsPerPage()` Returns the number of entry shown in the ResultFeed
`int`	`getLastPage()` Returns the last possible page (uses getTotalResults() and getItemsPerPage())
`Entry`	`getParentEntry()` Returns the parent entry of this feed.
`java.lang.String`	`getQuery()` Returns the query.
`java.util.List<java.lang.String>`	`getSpellCheckSuggestions()` Returns some spell suggestions
`java.util.List<SpellCheckSuggestion>`	`getSpellCheckSuggestionsAsObject()` Returns some spell suggestions
`int`	`getStartIndex()` Returns the starting index of the first entry.
`java.util.Map<java.lang.String,java.lang.String>`	`getStats()` Returns feed stats
`long`	`getTotalEntries()` Returns the number total number of entries.
`int`	`getTotalResults()` Deprecated. `getTotalEntries()`
`boolean`	`isEmbedded()` Returns true if the ResultFeed is embedded.
`boolean`	`isRootFeed()` Checks whether this feed is the root feed.
`void`	`setActAsFeed(java.lang.String actAsFeed)`
`void`	`setContext(java.lang.String context)`
`void`	`setEmbedded(boolean embedded)`
`void`	`setEntries(java.util.List<Entry> entries)`
`void`	`setError(java.lang.Exception error)`
`void`	`setFeedUri(java.lang.String feedUri)`
`void`	`setGenerator(java.lang.String generator)` Set the generator.
`void`	`setId(java.lang.String id)`
`void`	`setInfos(java.util.Map<java.lang.String,java.lang.String> infos)`
`void`	`setItemsPerPage(int itemsPerPage)`
`void`	`setParentEntry(Entry parentEntry)`
`void`	`setQuery(java.lang.String query)`
`void`	`setStartIndex(int startIndex)`
`void`	`setStats(java.util.Map<java.lang.String,java.lang.String> stats)`
`void`	`setTotalEntries(long totalEntries)`
`void`	`setTotalResults(int totalResults)` Deprecated. `setTotalResults(int)`

Methods inherited from class com.exalead.access.feedapi.FacetsContainer
addFacet, categoryIterator, getAssociatedValue, getFacet, getFacets, getFacetsMap, getNormalizedFacet, hasFacet, hasNormalizedFacet

Methods inherited from class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType
accept, collateTo, rawStringValue, resolveField, resolveOperation, setFlags, stringValue, stringValue, visit, visitBoolean, visitCategory, visitCategory, visitFacet, visitFacet, visitFeed, visitList, visitMeta, visitNumber, visitString, visitUnknown

Methods inherited from class com.exalead.access.feedapi.utils.AccessLogLevelConfiguration
toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.exalead.access.feedapi.HasFacets
addFacet, getFacet, getFacets, hasFacet

- Constructor Detail
  - ResultFeed
```
public ResultFeed(java.lang.String feedId,
                  java.lang.String generatorClassName)
```
  - ResultFeed
```
public ResultFeed(Feed feed)
```
- Method Detail
  - getId
```
public java.lang.String getId()
```
    Returns the feed identifier.
    
    Returns:
    
    the feed identifier
  - setId
```
public void setId(java.lang.String id)
```
  - getActAsFeed
```
public java.lang.String getActAsFeed()
```
    Returns whether this feed should act as another feed (ie. read the same parameter values).
    
    Returns:
    
    actAsFeed
  - setActAsFeed
```
public void setActAsFeed(java.lang.String actAsFeed)
```
  - getParentEntry
```
public Entry getParentEntry()
```
    Returns the parent entry of this feed.
    
    Returns:
    
    the parent entry of this feed
  - setParentEntry
```
public void setParentEntry(Entry parentEntry)
```
  - getGenerator
```
public java.lang.String getGenerator()
```
    Returns the basefeed classname used to create this ResultFeed
    
    Returns:
    
    the basefeed classname
  - setGenerator
```
public void setGenerator(java.lang.String generator)
```
    Set the generator.
    
    Parameters:
    
    generator -
  - getQuery
```
public java.lang.String getQuery()
```
    Returns the query.
    
    Returns:
    
    the query
  - setQuery
```
public void setQuery(java.lang.String query)
```
  - getContext
```
public java.lang.String getContext()
```
    Returns the context (eg: refines).
    
    Returns:
    
    the context
  - setContext
```
public void setContext(java.lang.String context)
```
  - getContextAsMap
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getContextAsMap()
```
    Returns the feed context as a Map.
    
    Returns:
    
    the feed context as a Map
  - getContextFullAsMap
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getContextFullAsMap()
```
    Returns the full feed context as a Map.
    
    Returns:
    
    the full feed context as a Map
  - getFeedUri
```
public java.lang.String getFeedUri()
```
    Returns the URI of the feed (useful for AJAX).
  - setFeedUri
```
public void setFeedUri(java.lang.String feedUri)
```
  - getTotalResults
```
public int getTotalResults()
```
    Deprecated. getTotalEntries()
    
    Returns the number of entries.
    
    Returns:
    
    the number of entries
  - setTotalResults
```
public void setTotalResults(int totalResults)
```
    Deprecated. setTotalResults(int)
  - getTotalEntries
```
public long getTotalEntries()
```
    Returns the number total number of entries.
    
    Returns:
    
    the total number of entries for this feed
  - setTotalEntries
```
public void setTotalEntries(long totalEntries)
```
  - getStartIndex
```
public int getStartIndex()
```
    Returns the starting index of the first entry.
    
    Returns:
    
    the starting index of the first entry
  - categoryIterator
```
public java.util.Iterator<Category> categoryIterator(java.lang.String root,
                                                     CategoryTreeContainer.IterationMode mode)
```
    Get a Category Iterator for the provided Category Root, using the provided IterationMode.
    
    Overrides:
    
    categoryIterator in class FacetsContainer
    
    Parameters:
    
    root -
    
    mode -
    
    Returns:
    
    a Category Iterator for the provided Category Root, using the provided IterationMode.
  - setStartIndex
```
public void setStartIndex(int startIndex)
```
  - getItemsPerPage
```
public int getItemsPerPage()
```
    Returns the number of entry shown in the ResultFeed
    
    Returns:
    
    the number of entry show in the ResultFeed
  - setItemsPerPage
```
public void setItemsPerPage(int itemsPerPage)
```
  - getLastPage
```
public int getLastPage()
```
    Returns the last possible page (uses getTotalResults() and getItemsPerPage())
    
    Returns:
    
    the last possible page
  - getCurrentPage
```
public int getCurrentPage()
```
    Returns the current page (uses getStartIndex() and getItemsPerPage())
    
    Returns:
    
    the current page
  - getEntries
```
public java.util.List<Entry> getEntries()
```
    Returns a list of entries
    
    Returns:
    
    entries
  - addEntry
```
public void addEntry(Entry entry)
```
    Adds the given entry to this feed.
    
    Parameters:
    
    entry - the given entry
  - setEntries
```
public void setEntries(java.util.List<Entry> entries)
```
  - getInfos
```
public java.util.Map<java.lang.String,java.lang.String> getInfos()
```
    Returns feed informations
    
    Returns:
    
    feed informations
  - addInfo
```
public void addInfo(java.lang.String name,
                    java.lang.String value)
```
    Helper which add an information to the ResultFeed
    
    Parameters:
    
    name -
    
    value -
  - setInfos
```
public void setInfos(java.util.Map<java.lang.String,java.lang.String> infos)
```
  - getStats
```
public java.util.Map<java.lang.String,java.lang.String> getStats()
```
    Returns feed stats
    
    Returns:
    
    feed stats
  - addStat
```
public void addStat(java.lang.String name,
                    java.lang.String value)
```
    Helper which add an stat data to the ResultFeed
    
    Parameters:
    
    name -
    
    value -
  - setStats
```
public void setStats(java.util.Map<java.lang.String,java.lang.String> stats)
```
  - isEmbedded
```
public boolean isEmbedded()
```
    Returns true if the ResultFeed is embedded. It means that the ResultFeed is empty and must be retrieved using the given feeduri (eg: ajax)
    
    Returns:
    
    true if the ResultFeed is embedded
  - setEmbedded
```
public void setEmbedded(boolean embedded)
```
  - isRootFeed
```
public boolean isRootFeed()
```
    Checks whether this feed is the root feed.
    
    Returns:
    
    true if this feed is the root feed, false otherwise.
  - getError
```
public java.lang.Exception getError()
```
    Returns the error exception
    
    Returns:
    
    the error exception
  - setError
```
public void setError(java.lang.Exception error)
```
  - getSpellCheckSuggestions
```
public java.util.List<java.lang.String> getSpellCheckSuggestions()
```
    Returns some spell suggestions
    
    Returns:
    
    a list of spell suggestions
  - addSpellCheckSuggestion
```
@Deprecated
public void addSpellCheckSuggestion(java.lang.String spellCheckSuggestion)
```
    Deprecated.
  - getSpellCheckSuggestionsAsObject
```
public java.util.List<SpellCheckSuggestion> getSpellCheckSuggestionsAsObject()
```
    Returns some spell suggestions
    
    Returns:
    
    a list of spell suggestions
  - addSpellCheckSuggestion
```
public void addSpellCheckSuggestion(SpellCheckSuggestion spellCheckSuggestion)
```
  - getExtraSerializedObjects
```
public java.util.HashMap<java.lang.String,ExtraSerializedObject> getExtraSerializedObjects()
```
    Returns extra objects that have been serialized
    
    Returns:
  - addExtraSerializedObject
```
public void addExtraSerializedObject(java.lang.String id,
                                     ExtraSerializedObject serializedObject)
```
  - clone
```
public java.lang.Object clone()
```
    Overrides:
    
    clone in class FacetsContainer
  - getFlags
```
public com.exalead.access.feedapi.eval.mel.extension.types.MELFlags getFlags()
```
    Specified by:
    
    getFlags in interface com.exalead.access.feedapi.eval.mel.extension.HasMELFlags
    
    Overrides:
    
    getFlags in class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType
  - getFields
```
public com.exalead.access.feedapi.eval.mel.extension.AbstractMELType.FieldsHolder getFields()
```
    Overrides:
    
    getFields in class FacetsContainer

Class ResultFeed

Nested Class Summary

Nested classes/interfaces inherited from interface com.exalead.access.feedapi.eval.mel.extension.MELType

Field Summary

Fields inherited from class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

Constructor Summary

Method Summary

Methods inherited from class com.exalead.access.feedapi.FacetsContainer

Methods inherited from class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

Methods inherited from class com.exalead.access.feedapi.utils.AccessLogLevelConfiguration

Methods inherited from class java.lang.Object

Methods inherited from interface com.exalead.access.feedapi.HasFacets

Constructor Detail

ResultFeed

ResultFeed

Method Detail

getId

setId

getActAsFeed

setActAsFeed

getParentEntry

setParentEntry

getGenerator

setGenerator

getQuery

setQuery

getContext

setContext

getContextAsMap

getContextFullAsMap

getFeedUri

setFeedUri

getTotalResults

setTotalResults

getTotalEntries

setTotalEntries

getStartIndex

categoryIterator

setStartIndex

getItemsPerPage

setItemsPerPage

getLastPage

getCurrentPage

getEntries

addEntry

setEntries

getInfos

addInfo

setInfos

getStats

addStat

setStats

isEmbedded

setEmbedded

isRootFeed

getError

setError

getSpellCheckSuggestions

addSpellCheckSuggestion

getSpellCheckSuggestionsAsObject

addSpellCheckSuggestion

getExtraSerializedObjects

addExtraSerializedObject

clone

getFlags

getFields