de.cismet.cidsx.server.api.types.legacy

Class ServerSearchFactory

java.lang.Object

de.cismet.cidsx.server.api.types.legacy.ServerSearchFactory

public class ServerSearchFactory
extends Object

Helper Methods for dealing with CidsServerSearch and and SearchInfo.

Version:

$Revision$, $Date$

Author:

Pascal Dihé

Method Summary

Modifier and Type	Method and Description
<C extends CidsServerSearch> Map<String,Method>	findSearchParameterReadMethods(Class<C> serverSearchClass) Helper method that introspects a CidsServerSearch Class and returns a map with all read methods for all readable and writable properties that correspond to the search parameters.
<C extends CidsServerSearch> Map<String,Class>	findSearchParameters(Class<C> serverSearchClass) Helper method that introspects a CidsServerSearch Class and returns a map with all readable and writable properties that correspond to the search parameters.
<C extends CidsServerSearch> Map<String,Method>	findSearchParameterWriteMethods(Class<C> serverSearchClass) Helper method that introspects a CidsServerSearch Class and returns a map with all write methods for all readable and writable properties that correspond to the search parameters.
static ServerSearchFactory	getFactory() DOCUMENT ME!
Class<? extends CidsServerSearch>	getServerSearchClass(String searchKey) Tries to find a cached CidsServerSearch class for the specified cids server search key.
de.cismet.cidsx.server.api.types.SearchInfo	getServerSearchInfo(String searchKey) Tries to find a cached SearchInfo object of the specified cids server search.
List<de.cismet.cidsx.server.api.types.SearchInfo>	getServerSearchInfos() Returns all cached ServerSearchInfos.
List<com.fasterxml.jackson.databind.JsonNode>	jsonNodesFromResultCollection(Collection searchResults, de.cismet.cidsx.server.api.types.SearchInfo searchInfo, ClassNameCache classNameCache) Converts a java.lang.Object collection search result to JSON Objects (ObjectNodes).
Collection	resultCollectionfromJsonNodes(List<com.fasterxml.jackson.databind.JsonNode> jsonNodes, de.cismet.cidsx.server.api.types.SearchInfo searchInfo) Converts a Jackson ObjectNode search result collection to the respective Java Objects.
de.cismet.cidsx.server.api.types.SearchInfo	searchInfoFromCidsServerSearch(CidsServerSearch cidsServerSearch) Inspects a CidsServerSearch Instance and tries to automatically serive a proper SearchInfo object.
de.cismet.cidsx.server.api.types.SearchParameters	searchParametersFromServerSearchInstance(String searchKey, CidsServerSearch cidsServerSearch) Extracts Search Parameters from a CidsServerSearch Search object.
CidsServerSearch	serverSearchInstanceFromSearchParameters(de.cismet.cidsx.server.api.types.SearchInfo searchInfo, List<de.cismet.cidsx.server.api.types.SearchParameter> searchParameters) Populates an instance of a CidsServerSearch with parameters from the searchParameters object.

Methods inherited from class java.lang.Object

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

Method Detail

getFactory

public static final ServerSearchFactory getFactory()

DOCUMENT ME!

Returns:

DOCUMENT ME!

searchInfoFromCidsServerSearch

public de.cismet.cidsx.server.api.types.SearchInfo searchInfoFromCidsServerSearch(CidsServerSearch cidsServerSearch)

Inspects a CidsServerSearch Instance and tries to automatically serive a proper SearchInfo object.

Parameters:

cidsServerSearch - server search to be inspected

Returns:

search info or null if the inspection fails

getServerSearchInfo

public de.cismet.cidsx.server.api.types.SearchInfo getServerSearchInfo(String searchKey)

Tries to find a cached SearchInfo object of the specified cids server search.

Parameters:

searchKey - the search key (e.g.java class name) of the search

Returns:

SearchInfo instance or null

getServerSearchInfos

public List<de.cismet.cidsx.server.api.types.SearchInfo> getServerSearchInfos()

Returns all cached ServerSearchInfos.

Returns:

ServerSearchInfo Collection

getServerSearchClass

public Class<? extends CidsServerSearch> getServerSearchClass(String searchKey)

Tries to find a cached CidsServerSearch class for the specified cids server search key.

Parameters:

searchKey - key (e.g. class name) of the server search

Returns:

CidsServerSearch Class or null

serverSearchInstanceFromSearchParameters

public CidsServerSearch serverSearchInstanceFromSearchParameters(de.cismet.cidsx.server.api.types.SearchInfo searchInfo,
                                                                 List<de.cismet.cidsx.server.api.types.SearchParameter> searchParameters)
                                                          throws Exception

Populates an instance of a CidsServerSearch with parameters from the searchParameters object.

Parameters:

searchInfo - meta information about a the CidsServerSearch

searchParameters - search parameters that are set in the instance

Returns:

CidsServerSearch with parameters

Throws:

Exception - if a parameter could not be set

searchParametersFromServerSearchInstance

public de.cismet.cidsx.server.api.types.SearchParameters searchParametersFromServerSearchInstance(String searchKey,
                                                                                                  CidsServerSearch cidsServerSearch)
                                                                                           throws Exception

Extracts Search Parameters from a CidsServerSearch Search object. Needs the respective SearchInfo and SearchParameterInfo to do so. Warning: Doesn't currently support MetaObject, MetaClass and MetaNode as they need special conversion before JSON serialization.

Parameters:

searchKey - DOCUMENT ME!

cidsServerSearch - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

resultCollectionfromJsonNodes

public Collection resultCollectionfromJsonNodes(List<com.fasterxml.jackson.databind.JsonNode> jsonNodes,
                                                de.cismet.cidsx.server.api.types.SearchInfo searchInfo)
                                         throws Exception

Converts a Jackson ObjectNode search result collection to the respective Java Objects. Support MetaClass, MetaObject, MetaNode by default and tries to deserialize binary (Base 64 encoded) and jackson serialized objects.
Warning:
Does not support automatic deserialization of LightWightMetaObjects! A helper method for LightWightMetaObject deserialization is available at lightweightMetaObjectFromCidsBean(de.cismet.cids.dynamics.CidsBean, int, java.lang.String, Sirius.server.newuser.User, de.cismet.cids.server.api.types.legacy.ClassNameCache)

Parameters:

jsonNodes - JSON object nodes to be converted

searchInfo - meta information needed for the type conversion

Returns:

collection of converted java object

Throws:

Exception - if any error occurs during the conversion

jsonNodesFromResultCollection

public List<com.fasterxml.jackson.databind.JsonNode> jsonNodesFromResultCollection(Collection searchResults,
                                                                                   de.cismet.cidsx.server.api.types.SearchInfo searchInfo,
                                                                                   ClassNameCache classNameCache)
                                                                            throws Exception

Converts a java.lang.Object collection search result to JSON Objects (ObjectNodes). Supports MetaClass, MetaObject, MetaNode by default and tries to serialize binary (Base 64 encoded) and plain java objects.
Warning:
Does not support automatic serialization of LightWightMetaObjects! A helper method for LightWightMetaObject to CidsBean serialization is available at )

Parameters:

searchResults - DOCUMENT ME!

searchInfo - DOCUMENT ME!

classNameCache - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

findSearchParameters

public <C extends CidsServerSearch> Map<String,Class> findSearchParameters(Class<C> serverSearchClass)
                                                                    throws IntrospectionException

Helper method that introspects a CidsServerSearch Class and returns a map with all readable and writable properties that correspond to the search parameters.

Type Parameters:

C - DOCUMENT ME!

Parameters:

serverSearchClass - server search class to be introspected

Returns:

map with property names and their classes

Throws:

IntrospectionException - if the server search class could not be introspected

findSearchParameterReadMethods

public <C extends CidsServerSearch> Map<String,Method> findSearchParameterReadMethods(Class<C> serverSearchClass)
                                                                               throws IntrospectionException

Helper method that introspects a CidsServerSearch Class and returns a map with all read methods for all readable and writable properties that correspond to the search parameters.

Type Parameters:

C - Class that extends CidsServerSearch

Parameters:

serverSearchClass - server search class to be introspected

Returns:

map with property names and their read methods

Throws:

IntrospectionException - if the server search class could not be introspected

findSearchParameterWriteMethods

public <C extends CidsServerSearch> Map<String,Method> findSearchParameterWriteMethods(Class<C> serverSearchClass)
                                                                                throws IntrospectionException

Helper method that introspects a CidsServerSearch Class and returns a map with all write methods for all readable and writable properties that correspond to the search parameters.

Type Parameters:

C - Class that extends CidsServerSearch

Parameters:

serverSearchClass - server search class to be introspected

Returns:

map with property names and their write methods

Throws:

IntrospectionException - if the server search class could not be introspected