com.exalead.access.feedapi

Class Feed

java.lang.Object

com.exalead.access.feedapi.utils.AccessLogLevelConfiguration

com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

com.exalead.access.feedapi.Feed

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>

public abstract class Feed
extends com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Feed.Constants
static class	Feed.FieldsHolder

Nested classes/interfaces inherited from class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

com.exalead.access.feedapi.eval.mel.extension.AbstractMELType.Field

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
Feed()

Method Summary

Modifier and Type	Method and Description
<R,P> R	accept(com.exalead.access.feedapi.eval.mel.extension.MELTypeVisitor<R,P> visitor, P p)
FeedTrigger.Result	afterQuery(QueryContext context, ResultFeed result) Generic after query routine that is called after the feed's execution.
FeedTrigger.Result	beforeQuery(QueryContext context) Generic before query routine that is called before the feed's execution.
void	disable(QueryContext context) Disable this feed for the current running query.
void	embed(QueryContext context, boolean embedFeed) Embed or not this feed for the current running query.
void	enable(QueryContext context) Enable this feed for the current running query.
abstract ResultFeed	execute(QueryContext context) Execute routine.
abstract ResultFeed	get(QueryContext context, java.lang.String id) Get routine.
java.lang.String	getActAsFeed() Internal use only: Returns whether this feed should act as another feed (ie.
com.exalead.access.feedapi.v10.Parameter[]	getAllSupportedParameters() Get the complete list of the supported parameters of the feed Note: you may NOT override this methods.
com.exalead.access.feedapi.v10.AvailableMetas	getAvailableMetas(java.util.Map<java.lang.String,java.lang.String[]> feedConf) Get the list of available metas for the given feed configuration.
com.exalead.access.configuration.v10.Feed.Property[]	getDefaultProperties() Get the default property mappings of the feed.
com.exalead.access.feedapi.v10.AvailableFeed	getDefinition() Return the feed definition
java.lang.String	getDescription() Return the description of this Feed.
abstract java.lang.String	getDisplayName() Return a human friendly name for this Feed, to be used by the Mashup Builder.
java.lang.String	getEvaluatedParameter(QueryContext context, java.lang.String name) Get the first evaluated value or NULL of a given feed Parameter, according to the current query and with resolved MEL expressions.
java.util.List<java.lang.String>	getEvaluatedParameters(QueryContext context, java.lang.String name) Get all evaluated values of a given feed Parameter, according to the current query and with resolved MEL expressions.
com.exalead.access.feedapi.eval.mel.extension.AbstractMELType.FieldsHolder	getFields()
java.lang.String	getFullId() Deprecated.
java.lang.String	getGroup() Return the group of this Feed.
java.lang.String	getId() Get the feed's ID
com.exalead.access.feedapi.v10.Parameter	getParameter(java.lang.String name) Get a specific Parameter given its name.
com.exalead.access.feedapi.v10.Parameter	getParameterByName(java.lang.String name) Deprecated.
java.util.List<com.exalead.access.feedapi.v10.Parameter>	getParameters() Get this feed's Parameter (raw, non resolved).
java.util.List<java.lang.String>	getParametersNames(QueryContext context) Get the values of the raw extra query string parameters The parameters are prefixed by the feed ID
java.util.List<java.lang.String>	getParametersNames(QueryContext context, boolean prefixParameters) Get the values of the raw extra query string parameters
java.util.List<java.lang.String>	getParametersNamesFromPattern(QueryContext context) Deprecated.
java.util.List<java.lang.String>	getParametersNamesFromPattern(QueryContext context, boolean prefixParameters) Deprecated.
java.lang.String	getParameterV(java.lang.String name) Returns the first value of the given parameter name
Feed	getSubFeed(java.lang.String id) Returns the subfeed corresponding to the provided id, and null if not found.
java.util.List<Feed>	getSubFeeds() Get this feed's subfeeds.
protected abstract com.exalead.access.feedapi.v10.Parameter[]	getSupportedParameters() Get the list of supported parameters by this Feed.
protected java.lang.String[]	getSupportedPatterns() Deprecated.
java.util.List<FeedTrigger>	getTriggers() Internal use only: Get this feed's triggers.
void	init() Initialization method, called on Feed construction.
java.lang.Boolean	isEmbedded(QueryContext context) Returns whether this feed is embed or not for the current running query.
java.lang.Boolean	isEmbeddedByDefault() Returns whether this feed is embed by default
boolean	isEnabled(QueryContext context) Returns true if the current feed is enable for the current running query.
boolean	isEnabledByDefault() Returns whether this feed is enabled by default or not.
boolean	isRootFeed(QueryContext context) Returns whether this feed is the "Root Feed" of the query.
boolean	isSynchronized() Get whether this feed is synchronized or not.
protected Entry	mapEntry(QueryContext context, Entry entry, com.exalead.access.configuration.v10.Feed.Property.MappingType mappingType) Map the feed's entry with the configured properties
void	mapPostResult(QueryContext context, Entry parentEntry, ResultFeed result) Results properties mapping routine, automatically fun pre|post feed's execution (according to the mappingType parameter).
ResultFeed	mapResult(QueryContext context, ResultFeed result, com.exalead.access.configuration.v10.Feed.Property.MappingType mappingType) Results properties mapping routine, automatically fun pre|post feed's execution (according to the mappingType parameter).
void	overrideParameter(QueryContext context, java.lang.String name, java.util.List<java.lang.String> values) Override the parameter "name" with the given "values" for the current running query.
void	overrideParameter(QueryContext context, java.lang.String name, java.lang.String value) Override the parameter "name" with the given "value" for the current running query.
void	setActAsFeed(java.lang.String actAsFeed) Internal use only: Set whether this feed should act as another feed (ie.
void	setEmbed(java.lang.Boolean embed) Internal use only: Specifies if this feed should be embed or not by default
void	setEnable(boolean enable) Internal use only: Set whether this feed should be enabled by default or not.
void	setId(java.lang.String id) Internal use only: Set the feed's ID The feed ID is unique with a page
void	setParameters(java.util.List<com.exalead.access.feedapi.v10.Parameter> parameters) Internal use only: Set the parameters (with raw, non resolved values) of this feed.
void	setProperties(java.util.List<com.exalead.access.configuration.v10.Feed.Property> properties) Internal use only: Set this feed's Properties mappings.
void	setSynchronized(boolean sync) Internal use only: Set whether this feed should be synchronized or not.
com.exalead.access.feedapi.v10.AvailableFeed	setupDefinition() Setup the feed definition with its supported parameters and how they should behave in the front-end.
void	uninit() Uninitialization method, called on Feed destruction (ex: When reloading the feed configuration).

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

collateTo, getFlags, 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

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

Constructor Detail

Feed

public Feed()

Method Detail

getDisplayName

public abstract java.lang.String getDisplayName()

Return a human friendly name for this Feed, to be used by the Mashup Builder.

Returns:

null to hide the feed from the Mashup Builder.

getGroup

public java.lang.String getGroup()

Return the group of this Feed.

getDescription

public java.lang.String getDescription()

Return the description of this Feed.

execute

public abstract ResultFeed execute(QueryContext context)
                            throws AccessException

Execute routine. Called when receiving a request without any specific ID.

Parameters:

context -

Returns:

Return the ResultFeed for the given QueryContext

Throws:

AccessException

get

public abstract ResultFeed get(QueryContext context,
                               java.lang.String id)
                        throws AccessException

Get routine. Called when receiving a request with a specific ID. Must return one and only one hit.

Parameters:

context -

id -

Throws:

AccessException

getAvailableMetas

public com.exalead.access.feedapi.v10.AvailableMetas getAvailableMetas(java.util.Map<java.lang.String,java.lang.String[]> feedConf)
                                                                throws AccessException

Get the list of available metas for the given feed configuration.

Parameters:

feedConf -

Throws:

AccessException

getSupportedParameters

protected abstract com.exalead.access.feedapi.v10.Parameter[] getSupportedParameters()

Get the list of supported parameters by this Feed.

Returns:

An array of supported Parameters

getAllSupportedParameters

public com.exalead.access.feedapi.v10.Parameter[] getAllSupportedParameters()

Get the complete list of the supported parameters of the feed Note: you may NOT override this methods.

Returns:

getSupportedPatterns

@Deprecated
protected java.lang.String[] getSupportedPatterns()

Deprecated.

Get the list of supported patterns by this Feed. The parameter patterns defined by this method will be automatically added to the feed definition. Example: - ".*" will let pass through ALL the parameters - "s\..* will let pass through the parameters prefixed by "s."

Returns:

An array of supported patterns

getDefaultProperties

public com.exalead.access.configuration.v10.Feed.Property[] getDefaultProperties()

Get the default property mappings of the feed. The property mappings defined by this method will be automatically added to the feed definition.

Returns:

init

public void init()
          throws java.lang.Exception

Initialization method, called on Feed construction. Can be overridden if you need clean up connections or other resources.

Throws:

java.lang.Exception

uninit

public void uninit()

Uninitialization method, called on Feed destruction (ex: When reloading the feed configuration). Can be overridden if you need clean up connections or other resources.

setupDefinition

public com.exalead.access.feedapi.v10.AvailableFeed setupDefinition()

Setup the feed definition with its supported parameters and how they should behave in the front-end. The list of supported parameters is created from it.

Returns:

disable

public void disable(QueryContext context)

Disable this feed for the current running query.

Parameters:

context -

enable

public void enable(QueryContext context)

Enable this feed for the current running query.

Parameters:

context -

isEnabled

public boolean isEnabled(QueryContext context)

Returns true if the current feed is enable for the current running query.

Parameters:

context -

Returns:

mapResult

public ResultFeed mapResult(QueryContext context,
                            ResultFeed result,
                            com.exalead.access.configuration.v10.Feed.Property.MappingType mappingType)
                     throws AccessException

Results properties mapping routine, automatically fun pre|post feed's execution (according to the mappingType parameter).

Parameters:

context -

result -

mappingType -

Returns:

Throws:

AccessException

mapPostResult

public void mapPostResult(QueryContext context,
                          Entry parentEntry,
                          ResultFeed result)
                   throws AccessException

Results properties mapping routine, automatically fun pre|post feed's execution (according to the mappingType parameter).

Parameters:

context -

result -

mappingType -

Throws:

AccessException

mapEntry

protected Entry mapEntry(QueryContext context,
                         Entry entry,
                         com.exalead.access.configuration.v10.Feed.Property.MappingType mappingType)
                  throws AccessException

Map the feed's entry with the configured properties

Parameters:

context -

entry -

mappingType -

Returns:

Throws:

AccessException

getParametersNames

public final java.util.List<java.lang.String> getParametersNames(QueryContext context)

Get the values of the raw extra query string parameters The parameters are prefixed by the feed ID

Parameters:

context -

Returns:

getParametersNamesFromPattern

@Deprecated
public final java.util.List<java.lang.String> getParametersNamesFromPattern(QueryContext context)

Deprecated.

getParametersNames

public final java.util.List<java.lang.String> getParametersNames(QueryContext context,
                                                                 boolean prefixParameters)

Get the values of the raw extra query string parameters

Parameters:

context -

prefixParameters - true to prefix parameters name with the feedId, false otherwise

Returns:

getParametersNamesFromPattern

@Deprecated
public final java.util.List<java.lang.String> getParametersNamesFromPattern(QueryContext context,
                                                                                        boolean prefixParameters)

Deprecated.

getEvaluatedParameters

public final java.util.List<java.lang.String> getEvaluatedParameters(QueryContext context,
                                                                     java.lang.String name)

Get all evaluated values of a given feed Parameter, according to the current query and with resolved MEL expressions.

Parameters:

context -

name -

Throws:

AccessException

getEvaluatedParameter

public final java.lang.String getEvaluatedParameter(QueryContext context,
                                                    java.lang.String name)

Get the first evaluated value or NULL of a given feed Parameter, according to the current query and with resolved MEL expressions.

Parameters:

context -

name -

beforeQuery

public FeedTrigger.Result beforeQuery(QueryContext context)

Generic before query routine that is called before the feed's execution. This method can be overridden to add logic to an existing feed.

Parameters:

context -

Returns:

afterQuery

public FeedTrigger.Result afterQuery(QueryContext context,
                                     ResultFeed result)

Generic after query routine that is called after the feed's execution. This method can be overridden to add logic to an existing feed.

Parameters:

context -

Returns:

overrideParameter

public final void overrideParameter(QueryContext context,
                                    java.lang.String name,
                                    java.util.List<java.lang.String> values)

Override the parameter "name" with the given "values" for the current running query.

Parameters:

context -

name -

values -

overrideParameter

public final void overrideParameter(QueryContext context,
                                    java.lang.String name,
                                    java.lang.String value)

Override the parameter "name" with the given "value" for the current running query.

Parameters:

context -

name -

value -

isRootFeed

public final boolean isRootFeed(QueryContext context)

Returns whether this feed is the "Root Feed" of the query. The root feed is the top level feed.

Parameters:

context -

Returns:

getDefinition

public final com.exalead.access.feedapi.v10.AvailableFeed getDefinition()

Return the feed definition

isEnabledByDefault

public boolean isEnabledByDefault()

Returns whether this feed is enabled by default or not.

Returns:

getSubFeeds

public final java.util.List<Feed> getSubFeeds()

Get this feed's subfeeds.

Returns:

getSubFeed

public final Feed getSubFeed(java.lang.String id)

Returns the subfeed corresponding to the provided id, and null if not found.

Parameters:

id -

Returns:

getFullId

@Deprecated
public final java.lang.String getFullId()

Deprecated.

Use the getId() method instead

Returns:

getId

public final java.lang.String getId()

Get the feed's ID

Returns:

embed

public void embed(QueryContext context,
                  boolean embedFeed)

Embed or not this feed for the current running query.

Parameters:

context -

embedFeed -

isEmbedded

public java.lang.Boolean isEmbedded(QueryContext context)

Returns whether this feed is embed or not for the current running query.

Returns:

isEmbeddedByDefault

public java.lang.Boolean isEmbeddedByDefault()

Returns whether this feed is embed by default

Returns:

getParameter

public com.exalead.access.feedapi.v10.Parameter getParameter(java.lang.String name)

Get a specific Parameter given its name.

Parameters:

name -

Returns:

getParameterV

public java.lang.String getParameterV(java.lang.String name)

Returns the first value of the given parameter name

Parameters:

name -

Returns:

null if none found

getParameters

public java.util.List<com.exalead.access.feedapi.v10.Parameter> getParameters()

Get this feed's Parameter (raw, non resolved).

Returns:

getParameterByName

@Deprecated
public final com.exalead.access.feedapi.v10.Parameter getParameterByName(java.lang.String name)

Deprecated.

isSynchronized

public boolean isSynchronized()

Get whether this feed is synchronized or not.

Returns:

setEnable

public void setEnable(boolean enable)

Internal use only: Set whether this feed should be enabled by default or not.

setId

public final void setId(java.lang.String id)

Internal use only: Set the feed's ID The feed ID is unique with a page

Parameters:

id -

setEmbed

public void setEmbed(java.lang.Boolean embed)

Internal use only: Specifies if this feed should be embed or not by default

Parameters:

embed -

See Also:

embed

setParameters

public void setParameters(java.util.List<com.exalead.access.feedapi.v10.Parameter> parameters)

Internal use only: Set the parameters (with raw, non resolved values) of this feed.

Parameters:

parameters -

setProperties

public void setProperties(java.util.List<com.exalead.access.configuration.v10.Feed.Property> properties)

Internal use only: Set this feed's Properties mappings.

Parameters:

properties -

getTriggers

public java.util.List<FeedTrigger> getTriggers()

Internal use only: Get this feed's triggers.

Returns:

setSynchronized

public void setSynchronized(boolean sync)

Internal use only: Set whether this feed should be synchronized or not.

Parameters:

sync -

setActAsFeed

public void setActAsFeed(java.lang.String actAsFeed)

Internal use only: Set whether this feed should act as another feed (ie. read the same parameter values).

Parameters:

actAsFeed -

getActAsFeed

public java.lang.String getActAsFeed()

Internal use only: Returns whether this feed should act as another feed (ie. read the same parameter values).

Returns:

actAsFeed

getFields

public com.exalead.access.feedapi.eval.mel.extension.AbstractMELType.FieldsHolder getFields()

Specified by:

getFields in class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

accept

public <R,P> R accept(com.exalead.access.feedapi.eval.mel.extension.MELTypeVisitor<R,P> visitor,
                      P p)

Specified by:

accept in interface com.exalead.access.feedapi.eval.mel.extension.MELType

Overrides:

accept in class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType