com.endeca.portal.mdex

Class DiscoveryServiceUtil

java.lang.Object

com.endeca.portal.mdex.DiscoveryServiceUtil

public class DiscoveryServiceUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CATCH_ALL_GROUP_KEY
static java.lang.String	CATCH_ALL_GROUP_NAME
static java.lang.String	DISCOVERY_PROPERTY_SORT_RECORD_COUNT
static java.lang.String	DISCOVERY_SERVICE
static java.lang.String	EID_PROPERTY_PREFIX Deprecated.
static java.lang.String	MDEX_DIMENSION_KEY
static java.lang.String	MDEX_IS_SINGLE_ASSIGN
static java.lang.String	MDEX_IS_UNIQUE
static java.lang.String	MDEX_PROPERTY_DISPLAYNAME
static java.lang.String	MDEX_PROPERTY_IS_TEXT_SEARCHABLE
static java.lang.String	MDEX_PROPERTY_IS_VALUE_SEARCHABLE
static java.lang.String	MDEX_PROPERTY_KEY
static java.lang.String	MDEX_PROPERTY_LANGUAGE
static java.lang.String	MDEX_PROPERTY_MULTI_SELECT
static java.lang.String	MDEX_PROPERTY_PREFIX
static java.lang.String	MDEX_PROPERTY_SORTING
static java.lang.String	MDEX_PROPERTY_TYPE
static java.lang.String	MDEX_SEMANTIC_PREFIX
static java.lang.String	NAMESPACE
static java.lang.String	REQUEST_XML_HEADER
static java.lang.String	SOAP_FOOTER
static java.lang.String	SOAP_HEADER
static java.lang.String	SYSTEM_PROPERTY_PREFIX

Constructor Summary

Constructors

Constructor and Description
DiscoveryServiceUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addConfigElement(com.endeca.mdex.conversation.types.Request request, com.endeca.mdex.conversation.types.ContentElementConfig config)
static void	addQueryTracking(java.net.HttpURLConnection connection, RequestIds requestIds) Instrument a MDEX 7 query by setting HTTP headers
static com.endeca.mdex.conversation.types.Request	clone(com.endeca.mdex.conversation.types.Request request)
static com.endeca.mdex.conversation.types.Request	cloneRequest(com.endeca.mdex.conversation.types.Request request)
static org.w3c.dom.Element	createElement(org.w3c.dom.Document document, java.lang.String elementName)
static com.endeca.mdex.conversation.types.Results	execute(long projectId, com.endeca.mdex.conversation.types.Request query, RequestIds requestIds)
static com.endeca.mdex.conversation.types.Results	execute(long projectId, com.endeca.mdex.conversation.types.Request query, RequestIds requestIds, java.lang.String logMsg)
static com.endeca.mdex.conversation.types.Results	execute(javax.portlet.PortletRequest request, com.endeca.mdex.conversation.types.Request query, RequestIds requestIds)
static com.endeca.mdex.conversation.types.Results	execute(javax.portlet.PortletRequest request, com.endeca.mdex.conversation.types.Request query, RequestIds requestIds, java.lang.String logMsg)
static <T> T	fromXML(java.lang.String xmlString, java.lang.Class<T> klass)
static java.util.List<com.endeca.mdex.conversation.types.TextValueSearch>	getAllAttributeTextValueSearches(com.endeca.mdex.conversation.types.Results results)
static java.util.List<com.endeca.mdex.conversation.types.TextValueSearch>	getAllAttributeValueSearches(com.endeca.mdex.conversation.types.Results results)
static java.util.List<com.endeca.mdex.conversation.types.Breadcrumbs>	getAllBreadcrumbs(com.endeca.mdex.conversation.types.Results results)
static <T extends com.endeca.mdex.conversation.types.ContentElementConfig> java.util.List<T>	getAllContentElementConfigs(com.endeca.mdex.conversation.types.Request request, java.lang.Class<T> klass)
static <T extends com.endeca.mdex.conversation.types.ContentElement> java.util.List<T>	getAllContentElements(com.endeca.mdex.conversation.types.Results results, java.lang.Class<T> klass)
static java.util.List<com.endeca.mdex.conversation.types.EQL>	getAllEQL(com.endeca.mdex.conversation.types.Results results)
static java.util.List<RecordCount>	getAllRecordCounts(com.endeca.mdex.conversation.types.Results results)
static java.util.List<RecordDetails>	getAllRecordDetails(com.endeca.mdex.conversation.types.Results results)
static java.util.List<com.endeca.mdex.conversation.types.RecordList>	getAllRecordLists(com.endeca.mdex.conversation.types.Results results)
static java.util.List<com.endeca.mdex.conversation.types.SearchAdjustments>	getAllSearchAdjustments(com.endeca.mdex.conversation.types.Results results)
static com.endeca.mdex.conversation.types.TextValueSearch	getAttributeTextValueSearch(com.endeca.mdex.conversation.types.Results results)
static com.endeca.mdex.conversation.types.TextValueSearch	getAttributeValueSearch(com.endeca.mdex.conversation.types.Results results)
static com.endeca.mdex.conversation.types.Breadcrumbs	getBreadcrumbs(com.endeca.mdex.conversation.types.Results results)
static com.endeca.mdex.conversation.types.ContentElementConfig	getConfigById(com.endeca.mdex.conversation.types.Request request, java.lang.String id)
static <T extends com.endeca.mdex.conversation.types.ContentElement> T	getContentElement(com.endeca.mdex.conversation.types.Results results, java.lang.Class<T> klass)
static <T extends com.endeca.mdex.conversation.types.ContentElementConfig> T	getContentElementConfig(com.endeca.mdex.conversation.types.Request request, java.lang.Class<T> klass)
static com.endeca.mdex.conversation.types.EQL	getEQL(com.endeca.mdex.conversation.types.Results results)
static com.endeca.mdex.conversation.types.State	getNamedState(com.endeca.mdex.conversation.types.Request req, java.lang.String stateName) Find a named State in a conversation service Request.
static com.endeca.mdex.conversation.types.State	getNamedState(com.endeca.mdex.conversation.types.Results res, java.lang.String stateName) Find a named State in conversation service Results.
static long	getNumRecords(com.endeca.mdex.conversation.types.Results results) Convenience method to return the number of records in the result from either a RecordCount or RecordList element
static com.endeca.mdex.conversation.types.State	getOrCreateNamedState(com.endeca.mdex.conversation.types.Request req, java.lang.String stateName) Tries to find the named state if it already exists on the Request.
static RecordCount	getRecordCount(com.endeca.mdex.conversation.types.Results results)
static RecordDetails	getRecordDetails(com.endeca.mdex.conversation.types.Results results)
static com.endeca.mdex.conversation.types.RecordList	getRecordList(com.endeca.mdex.conversation.types.Results results)
static com.endeca.mdex.conversation.types.SearchAdjustments	getSearchAdjustments(com.endeca.mdex.conversation.types.Results results)
static void	setupNamedStates(com.endeca.mdex.conversation.types.Request req, java.util.Collection<CollectionBaseView> baseViews) Initializes named states on the specified CS Request for all Collections in the system.
static void	setupNamedStates(com.endeca.mdex.conversation.types.Request req, java.util.Collection<CollectionBaseView> baseViews, QueryState state) Initializes named states on the specified CS Request for all Collections in the system and all the custom states through setting stateNameOverride in query functions.
static java.lang.String	toSoap(com.endeca.mdex.conversation.types.Request request) Create a SOAP request corresponding with the given request object
static java.lang.String	toXML(com.endeca.mdex.conversation.types.Request request)
static java.lang.String	toXML(com.endeca.mdex.conversation.types.Results results)

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

DISCOVERY_SERVICE

public static final java.lang.String DISCOVERY_SERVICE

See Also:

Constant Field Values

MDEX_PROPERTY_KEY

public static final java.lang.String MDEX_PROPERTY_KEY

See Also:

Constant Field Values

MDEX_PROPERTY_TYPE

public static final java.lang.String MDEX_PROPERTY_TYPE

See Also:

Constant Field Values

MDEX_IS_UNIQUE

public static final java.lang.String MDEX_IS_UNIQUE

See Also:

Constant Field Values

MDEX_IS_SINGLE_ASSIGN

public static final java.lang.String MDEX_IS_SINGLE_ASSIGN

See Also:

Constant Field Values

MDEX_PROPERTY_DISPLAYNAME

public static final java.lang.String MDEX_PROPERTY_DISPLAYNAME

See Also:

Constant Field Values

MDEX_DIMENSION_KEY

public static final java.lang.String MDEX_DIMENSION_KEY

See Also:

Constant Field Values

MDEX_PROPERTY_IS_VALUE_SEARCHABLE

public static final java.lang.String MDEX_PROPERTY_IS_VALUE_SEARCHABLE

See Also:

Constant Field Values

MDEX_PROPERTY_IS_TEXT_SEARCHABLE

public static final java.lang.String MDEX_PROPERTY_IS_TEXT_SEARCHABLE

See Also:

Constant Field Values

MDEX_PROPERTY_LANGUAGE

public static final java.lang.String MDEX_PROPERTY_LANGUAGE

See Also:

Constant Field Values

MDEX_PROPERTY_MULTI_SELECT

public static final java.lang.String MDEX_PROPERTY_MULTI_SELECT

See Also:

Constant Field Values

MDEX_PROPERTY_SORTING

public static final java.lang.String MDEX_PROPERTY_SORTING

See Also:

Constant Field Values

MDEX_PROPERTY_PREFIX

public static final java.lang.String MDEX_PROPERTY_PREFIX

See Also:

Constant Field Values

MDEX_SEMANTIC_PREFIX

public static final java.lang.String MDEX_SEMANTIC_PREFIX

See Also:

Constant Field Values

SYSTEM_PROPERTY_PREFIX

public static final java.lang.String SYSTEM_PROPERTY_PREFIX

See Also:

Constant Field Values

DISCOVERY_PROPERTY_SORT_RECORD_COUNT

public static final java.lang.String DISCOVERY_PROPERTY_SORT_RECORD_COUNT

See Also:

Constant Field Values

EID_PROPERTY_PREFIX

@Deprecated
public static final java.lang.String EID_PROPERTY_PREFIX

Deprecated.

See Also:

Constant Field Values

CATCH_ALL_GROUP_KEY

public static final java.lang.String CATCH_ALL_GROUP_KEY

See Also:

Constant Field Values

CATCH_ALL_GROUP_NAME

public static final java.lang.String CATCH_ALL_GROUP_NAME

See Also:

Constant Field Values

REQUEST_XML_HEADER

public static final java.lang.String REQUEST_XML_HEADER

See Also:

Constant Field Values

SOAP_HEADER

public static final java.lang.String SOAP_HEADER

See Also:

Constant Field Values

SOAP_FOOTER

public static final java.lang.String SOAP_FOOTER

See Also:

Constant Field Values

Constructor Detail

DiscoveryServiceUtil

public DiscoveryServiceUtil()

Method Detail

getNamedState

public static com.endeca.mdex.conversation.types.State getNamedState(com.endeca.mdex.conversation.types.Request req,
                                                     java.lang.String stateName)
                                                              throws StateNotFoundException

Find a named State in a conversation service Request.

Parameters:

req - a conversation service Request

stateName - name of the State to seek in req

Returns:

matching State

Throws:

StateNotFoundException - if the specified named state cannot be found in the Request

Since:

3.1 (Collections epic)

getOrCreateNamedState

public static com.endeca.mdex.conversation.types.State getOrCreateNamedState(com.endeca.mdex.conversation.types.Request req,
                                                             java.lang.String stateName)

Tries to find the named state if it already exists on the Request. If it doesn't yet exist, a new State is created and added to the Request.

Parameters:

req - a conversation service Request

stateName - name of a State to seek in req

Returns:

State matching specified name or a newly created one

Since:

3.1 (Collections epic)

setupNamedStates

public static void setupNamedStates(com.endeca.mdex.conversation.types.Request req,
                    java.util.Collection<CollectionBaseView> baseViews)

Initializes named states on the specified CS Request for all Collections in the system.

Parameters:

req - a CS Request

baseViews - all collections for which to generate named states

setupNamedStates

public static void setupNamedStates(com.endeca.mdex.conversation.types.Request req,
                    java.util.Collection<CollectionBaseView> baseViews,
                    QueryState state)

Initializes named states on the specified CS Request for all Collections in the system and all the custom states through setting stateNameOverride in query functions.

Parameters:

req - a CS Request

baseViews - all collections for which to generate named states

getNamedState

public static com.endeca.mdex.conversation.types.State getNamedState(com.endeca.mdex.conversation.types.Results res,
                                                     java.lang.String stateName)
                                                              throws StateNotFoundException

Find a named State in conversation service Results.

Parameters:

res - conversation service Results

stateName - name of the State to seek in res

Returns:

matching State

Throws:

StateNotFoundException - if the specified named state cannot be found in the Results

Since:

3.1 (Collections epic)f

getRecordList

public static com.endeca.mdex.conversation.types.RecordList getRecordList(com.endeca.mdex.conversation.types.Results results)

getAllRecordLists

public static java.util.List<com.endeca.mdex.conversation.types.RecordList> getAllRecordLists(com.endeca.mdex.conversation.types.Results results)

getRecordDetails

public static RecordDetails getRecordDetails(com.endeca.mdex.conversation.types.Results results)

getAllRecordDetails

public static java.util.List<RecordDetails> getAllRecordDetails(com.endeca.mdex.conversation.types.Results results)

getAttributeValueSearch

public static com.endeca.mdex.conversation.types.TextValueSearch getAttributeValueSearch(com.endeca.mdex.conversation.types.Results results)

getAllAttributeValueSearches

public static java.util.List<com.endeca.mdex.conversation.types.TextValueSearch> getAllAttributeValueSearches(com.endeca.mdex.conversation.types.Results results)

getAttributeTextValueSearch

public static com.endeca.mdex.conversation.types.TextValueSearch getAttributeTextValueSearch(com.endeca.mdex.conversation.types.Results results)

getAllAttributeTextValueSearches

public static java.util.List<com.endeca.mdex.conversation.types.TextValueSearch> getAllAttributeTextValueSearches(com.endeca.mdex.conversation.types.Results results)

getBreadcrumbs

public static com.endeca.mdex.conversation.types.Breadcrumbs getBreadcrumbs(com.endeca.mdex.conversation.types.Results results)

getAllBreadcrumbs

public static java.util.List<com.endeca.mdex.conversation.types.Breadcrumbs> getAllBreadcrumbs(com.endeca.mdex.conversation.types.Results results)

getEQL

public static com.endeca.mdex.conversation.types.EQL getEQL(com.endeca.mdex.conversation.types.Results results)

getAllEQL

public static java.util.List<com.endeca.mdex.conversation.types.EQL> getAllEQL(com.endeca.mdex.conversation.types.Results results)

getSearchAdjustments

public static com.endeca.mdex.conversation.types.SearchAdjustments getSearchAdjustments(com.endeca.mdex.conversation.types.Results results)

getAllSearchAdjustments

public static java.util.List<com.endeca.mdex.conversation.types.SearchAdjustments> getAllSearchAdjustments(com.endeca.mdex.conversation.types.Results results)

getRecordCount

public static RecordCount getRecordCount(com.endeca.mdex.conversation.types.Results results)

getAllRecordCounts

public static java.util.List<RecordCount> getAllRecordCounts(com.endeca.mdex.conversation.types.Results results)

getNumRecords

public static long getNumRecords(com.endeca.mdex.conversation.types.Results results)

Convenience method to return the number of records in the result from either a RecordCount or RecordList element

Parameters:

results -

Returns:

the numer of records

getConfigById

public static com.endeca.mdex.conversation.types.ContentElementConfig getConfigById(com.endeca.mdex.conversation.types.Request request,
                                                                    java.lang.String id)

getContentElement

public static <T extends com.endeca.mdex.conversation.types.ContentElement> T getContentElement(com.endeca.mdex.conversation.types.Results results,
                                                                                java.lang.Class<T> klass)

getAllContentElements

public static <T extends com.endeca.mdex.conversation.types.ContentElement> java.util.List<T> getAllContentElements(com.endeca.mdex.conversation.types.Results results,
                                                                                                    java.lang.Class<T> klass)

getContentElementConfig

public static <T extends com.endeca.mdex.conversation.types.ContentElementConfig> T getContentElementConfig(com.endeca.mdex.conversation.types.Request request,
                                                                                            java.lang.Class<T> klass)

getAllContentElementConfigs

public static <T extends com.endeca.mdex.conversation.types.ContentElementConfig> java.util.List<T> getAllContentElementConfigs(com.endeca.mdex.conversation.types.Request request,
                                                                                                                java.lang.Class<T> klass)

addConfigElement

public static void addConfigElement(com.endeca.mdex.conversation.types.Request request,
                    com.endeca.mdex.conversation.types.ContentElementConfig config)

createElement

public static org.w3c.dom.Element createElement(org.w3c.dom.Document document,
                                java.lang.String elementName)
                                         throws javax.xml.parsers.ParserConfigurationException

Throws:

javax.xml.parsers.ParserConfigurationException

toSoap

public static java.lang.String toSoap(com.endeca.mdex.conversation.types.Request request)
                               throws javax.xml.bind.JAXBException

Create a SOAP request corresponding with the given request object

Parameters:

request -

Returns:

String containing the SOAP request

Throws:

javax.xml.bind.JAXBException

toXML

public static java.lang.String toXML(com.endeca.mdex.conversation.types.Request request)
                              throws javax.xml.bind.JAXBException

Throws:

javax.xml.bind.JAXBException

toXML

public static java.lang.String toXML(com.endeca.mdex.conversation.types.Results results)
                              throws javax.xml.bind.JAXBException

Throws:

javax.xml.bind.JAXBException

fromXML

public static <T> T fromXML(java.lang.String xmlString,
            java.lang.Class<T> klass)
                 throws javax.xml.bind.JAXBException

Throws:

javax.xml.bind.JAXBException

clone

public static com.endeca.mdex.conversation.types.Request clone(com.endeca.mdex.conversation.types.Request request)
                                                        throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

cloneRequest

public static com.endeca.mdex.conversation.types.Request cloneRequest(com.endeca.mdex.conversation.types.Request request)
                                                               throws javax.xml.bind.JAXBException

Throws:

javax.xml.bind.JAXBException

execute

public static com.endeca.mdex.conversation.types.Results execute(javax.portlet.PortletRequest request,
                                                 com.endeca.mdex.conversation.types.Request query,
                                                 RequestIds requestIds)
                                                          throws DataSourceException

Throws:

DataSourceException

execute

public static com.endeca.mdex.conversation.types.Results execute(javax.portlet.PortletRequest request,
                                                 com.endeca.mdex.conversation.types.Request query,
                                                 RequestIds requestIds,
                                                 java.lang.String logMsg)
                                                          throws DataSourceException

Throws:

DataSourceException

execute

public static com.endeca.mdex.conversation.types.Results execute(long projectId,
                                                 com.endeca.mdex.conversation.types.Request query,
                                                 RequestIds requestIds)
                                                          throws DataSourceException

Throws:

DataSourceException

execute

public static com.endeca.mdex.conversation.types.Results execute(long projectId,
                                                 com.endeca.mdex.conversation.types.Request query,
                                                 RequestIds requestIds,
                                                 java.lang.String logMsg)
                                                          throws DataSourceException

Throws:

DataSourceException

addQueryTracking

public static void addQueryTracking(java.net.HttpURLConnection connection,
                    RequestIds requestIds)

Instrument a MDEX 7 query by setting HTTP headers

Parameters:

connection - the connection for the query

requestIds - the tracker containing the session, request, etc. tokens