|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.portal.data.DataSource
public class DataSource
DataSource instances encapsulate a connection to an MDEX Engine, a current
QueryState
on the connection, handles the logic of executing a
query on an MDEX to get results, and handles the logic of altering the
QueryState
.
QueryState
Constructor Summary | |
---|---|
DataSource(javax.portlet.PortletRequest request,
java.lang.String dataSourceId)
Construct a DataSource instance referring to a particular data source. |
Method Summary | |
---|---|
com.endeca.mdex.conversation.Request |
createDiscoveryServiceQuery(QueryState state)
Create a Discovery Service Request instance from a query state, using the current request state. |
com.endeca.mdex.conversation.Request |
createDiscoveryServiceQuery(QueryState state,
com.endeca.mdex.conversation.Request requestState)
Create a Discovery Service Request instance from a query state, given a request state |
com.endeca.navigation.ENEQuery |
createENEQuery()
Create an ENEQuery object from the data source's current state. |
com.endeca.navigation.ENEQuery |
createENEQuery(QueryState state)
Create an ENEQuery object based on the specified query state |
QueryResults |
execute()
Deprecated. |
com.endeca.navigation.ENEQueryResults |
execute(com.endeca.navigation.ENEQuery query)
Applies security filters as managed by the MDEX Security Manager and executes query |
QueryResults |
execute(QueryState queryState)
Executes a query representing the underlying MDEX State's QueryState and the current RequestState. |
QueryResults |
execute(QueryState queryState,
com.endeca.mdex.conversation.Request requestState)
Executes a query represented by a QueryState and a RequestState. |
com.endeca.mdex.conversation.Results |
execute(com.endeca.mdex.conversation.Request query)
Applies security and executes query against the current request's FilterState. |
java.lang.String |
getDescription()
get the DataSource's description |
javax.xml.namespace.QName |
getEventName()
Retrieve the event name that gets fired/listened for when this data source changes. |
java.lang.String |
getId()
get the DataSource's ID |
QueryState |
getInitialQueryState()
Retrieve the initial QueryState on this data source, which is the QueryState defined in the data source's initial JSON configuration |
MDEXAttributeList |
getMDEXAttributes()
Retrieves a list of attributes available in the MDEX engine, by performing a key properties query and wrapping the results for convenience. |
protected MDEXState |
getMDEXState()
|
java.lang.String |
getName()
get the DataSource's name |
QueryState |
getQueryState()
Retrieve the current query state on this data source. |
com.endeca.mdex.conversation.Request |
getRequestState()
This method is only used when your data source and portlet support MDEX 7 and the Discovery Service API. |
protected UserSession |
getUserSession()
|
MDEXState.APIVersion |
getVersion()
Get what APIVersion this data source supports. |
boolean |
isAvailable()
|
void |
resetQueryState()
Reset the data source's query state to what it's initial state was. |
void |
setQueryState(QueryState newState)
Set the state of this data source. |
boolean |
supportsDiscoveryService()
|
boolean |
supportsENEQuery()
|
boolean |
supportsFeature(Feature f)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DataSource(javax.portlet.PortletRequest request, java.lang.String dataSourceId) throws DataSourceException
EndecaPortlet.getDataSource(PortletRequest)
inside your portlet
in most instances.
request
- The current request objectdataSourceId
- The id of the data source to represent
DataSourceException
Method Detail |
---|
protected UserSession getUserSession() throws UserSessionException
UserSessionException
protected MDEXState getMDEXState()
public java.lang.String getName()
public java.lang.String getDescription()
public java.lang.String getId()
public javax.xml.namespace.QName getEventName()
public MDEXState.APIVersion getVersion()
supportsENEQuery()
or supportsDiscoveryService()
instead of this method.
public com.endeca.mdex.conversation.Request getRequestState()
public boolean supportsENEQuery()
public boolean supportsDiscoveryService()
public boolean isAvailable()
public boolean supportsFeature(Feature f)
public QueryState getQueryState() throws DataSourceException
DataSourceException
public void setQueryState(QueryState newState) throws DataSourceException
newState
- The new state to "push"
DataSourceException
public QueryState getInitialQueryState()
public void resetQueryState() throws DataSourceException
DataSourceException
@Deprecated public QueryResults execute() throws DataSourceException
DataSourceException
public QueryResults execute(QueryState queryState, com.endeca.mdex.conversation.Request requestState) throws DataSourceException
queryState
- requestState
-
DataSourceException
public QueryResults execute(QueryState queryState) throws DataSourceException
queryState
-
DataSourceException
public MDEXAttributeList getMDEXAttributes() throws DataSourceException
DataSourceException
public com.endeca.navigation.ENEQuery createENEQuery() throws DataSourceException
DataSourceException
QueryState
,
createDiscoveryServiceQuery(QueryState)
public com.endeca.navigation.ENEQuery createENEQuery(QueryState state) throws DataSourceException
state
-
DataSourceException
createENEQuery()
,
createDiscoveryServiceQuery(QueryState)
public com.endeca.navigation.ENEQueryResults execute(com.endeca.navigation.ENEQuery query) throws DataSourceException
query
- the query to execute.
DataSourceException
public com.endeca.mdex.conversation.Results execute(com.endeca.mdex.conversation.Request query) throws DataSourceException
query
- The query to execute
DataSourceException
public com.endeca.mdex.conversation.Request createDiscoveryServiceQuery(QueryState state, com.endeca.mdex.conversation.Request requestState) throws DataSourceException
state
- the query staterequestState
- the conversation service
DataSourceException
createENEQuery(QueryState)
public com.endeca.mdex.conversation.Request createDiscoveryServiceQuery(QueryState state) throws DataSourceException
state
-
DataSourceException
createENEQuery(QueryState)
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |