com.exalead.access.feedapi

Class Entry

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.Entry

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 Entry
extends FacetsContainer
implements HasFacets, java.lang.Cloneable, java.io.Serializable

Entry contains hit informations, metas, subfeeds, links, image and title.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Entry.Field
static class	Entry.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>

Field Summary

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

flags

Constructor Summary

Constructors

Constructor and Description
Entry()
Entry(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	addHitInfo(java.lang.String key, java.lang.String value) Helper which add a Hit Info to the Entry
void	addMeta(Meta meta) Helper which add a given Meta object to the Entry
void	addMeta(java.lang.String name, java.lang.String value) Helper which add a new Meta to the Entry
void	addMeta(java.lang.String name, java.lang.String value, HighlightInterval[] highlight) Helper to create a Meta in the current Entry.
void	addMeta(java.lang.String name, java.lang.String value, MetaValue.HighlightInterval[] highlight) Deprecated. as of 2013x release, replaced by addMeta(String, String, HighlightInterval[]).
void	addSubfeed(ResultFeed subFeed) Adds a given sub-feed to this entry.
void	addUri(java.lang.String uriName, java.lang.String uri) Helper which add an URI to the Entry
java.lang.Object	clone()
java.lang.String	getContent() Returns the entry content (e.g: text for cloudview)
java.lang.String	getDataModelClass() Returns the data model class of the entry
java.lang.String	getEntryUri() Returns the entry URI
Feed	getFeed() internal use only
com.exalead.access.feedapi.eval.mel.extension.AbstractMELType.FieldsHolder	getFields()
com.exalead.access.feedapi.eval.mel.extension.types.MELFlags	getFlags()
java.lang.String	getId() Returns the entry id (eg: the id for cloudview)
java.lang.String	getImage() Returns the entry image
java.util.Map<java.lang.String,java.lang.String>	getInfos() Returns Entry informations
Meta	getMeta(java.lang.String name) Returns a Meta
java.util.LinkedHashMap<java.lang.String,Meta>	getMetas() Returns an HashMap of Meta.
ResultFeed	getParentFeed() Returns the parent feed of this entry
java.util.List<ResultFeed>	getSubfeeds() Returns a list of subfeeds
java.lang.String	getTitle() Returns the entry title
java.util.List<com.exalead.cv360.generics.Pair<java.lang.String,java.lang.String>>	getUris() Returns a list of URIs
boolean	isRootEntry() Return whether this entry is the Top level one or not.
void	setContent(java.lang.String content)
void	setEntryUri(java.lang.String entryUri)
void	setFeed(Feed feed) internal use only
void	setId(java.lang.String id)
void	setImage(java.lang.String image)
void	setInfos(java.util.Map<java.lang.String,java.lang.String> infos)
void	setMetas(java.util.LinkedHashMap<java.lang.String,Meta> metas)
void	setParentFeed(ResultFeed parentFeed)
void	setRootEntry(boolean rootEntry)
ResultFeed	setSubfeed(int index, ResultFeed subFeed, boolean force) Replaces the sub-feed at the specified position in the sub-feed list of this entry with the specified sub-feed.
void	setTitle(java.lang.String title)

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

addFacet, categoryIterator, 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

Entry

public Entry()

Entry

public Entry(java.lang.String id)

Method Detail

getId

public java.lang.String getId()

Returns the entry id (eg: the id for cloudview)

Returns:

the entry id

setId

public void setId(java.lang.String id)

getInfos

public java.util.Map<java.lang.String,java.lang.String> getInfos()

Returns Entry informations

Returns:

entry informations

setInfos

public void setInfos(java.util.Map<java.lang.String,java.lang.String> infos)

getUris

public java.util.List<com.exalead.cv360.generics.Pair<java.lang.String,java.lang.String>> getUris()

Returns a list of URIs

Returns:

a list of URIs

getSubfeeds

public java.util.List<ResultFeed> getSubfeeds()

Returns a list of subfeeds

Returns:

a list of subfeeds

getTitle

public java.lang.String getTitle()

Returns the entry title

Returns:

the entry title

setTitle

public void setTitle(java.lang.String title)

getImage

public java.lang.String getImage()

Returns the entry image

Returns:

the entry image

setImage

public void setImage(java.lang.String image)

getContent

public java.lang.String getContent()

Returns the entry content (e.g: text for cloudview)

Returns:

the entry content

setContent

public void setContent(java.lang.String content)

getEntryUri

public java.lang.String getEntryUri()

Returns the entry URI

Returns:

the entry URI

setEntryUri

public void setEntryUri(java.lang.String entryUri)

getDataModelClass

public java.lang.String getDataModelClass()

Returns the data model class of the entry

Returns:

getMetas

public java.util.LinkedHashMap<java.lang.String,Meta> getMetas()

Returns an HashMap of Meta. The key is the meta name and the value its Meta

Returns:

an HashMap of Meta

setMetas

public void setMetas(java.util.LinkedHashMap<java.lang.String,Meta> metas)

isRootEntry

public boolean isRootEntry()

Return whether this entry is the Top level one or not.

setRootEntry

public void setRootEntry(boolean rootEntry)

getMeta

public Meta getMeta(java.lang.String name)

Returns a Meta

Parameters:

name - Meta name

Returns:

a Meta

addMeta

public void addMeta(java.lang.String name,
                    java.lang.String value)

Helper which add a new Meta to the Entry

Parameters:

name - Meta name

value - Meta value

addMeta

@Deprecated
public void addMeta(java.lang.String name,
                                java.lang.String value,
                                MetaValue.HighlightInterval[] highlight)

Deprecated. as of 2013x release, replaced by addMeta(String, String, HighlightInterval[]).

Helper to create a Meta in the current Entry.

addMeta

public void addMeta(java.lang.String name,
                    java.lang.String value,
                    HighlightInterval[] highlight)

Helper to create a Meta in the current Entry.

Parameters:

name -

value -

highlight -

addMeta

public void addMeta(Meta meta)

Helper which add a given Meta object to the Entry

Parameters:

meta -

addHitInfo

public void addHitInfo(java.lang.String key,
                       java.lang.String value)

Helper which add a Hit Info to the Entry

Parameters:

key -

value -

addUri

public void addUri(java.lang.String uriName,
                   java.lang.String uri)

Helper which add an URI to the Entry

Parameters:

uriName -

uri -

addSubfeed

public void addSubfeed(ResultFeed subFeed)

Adds a given sub-feed to this entry.

Parameters:

subFeed - the given sub-feed

setSubfeed

public ResultFeed setSubfeed(int index,
                             ResultFeed subFeed,
                             boolean force)

Replaces the sub-feed at the specified position in the sub-feed list of this entry with the specified sub-feed.

Parameters:

index - index of the sub-feed to replace

subFeed - sub-feed to be stored at the specified position

force - true to append null feeds before the specified position if position >= number of sub-feeds, false otherwise.

Returns:

the sub-feed previously at the specified position

getParentFeed

public ResultFeed getParentFeed()

Returns the parent feed of this entry

Returns:

setParentFeed

public void setParentFeed(ResultFeed parentFeed)

setFeed

public void setFeed(Feed feed)

internal use only

getFeed

public Feed getFeed()

internal use only

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class FacetsContainer

Throws:

java.lang.CloneNotSupportedException

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