de.samply.share.utils

Class QueryConverter

java.lang.Object

de.samply.share.utils.QueryConverter

public class QueryConverter
extends Object

Utility class to transform and manipulate query objects.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	logger
static String	XMLNS_PATH_CCP
static String	XMLNS_PATH_COMMON
static String	XMLNS_PATH_OSSE

Method Summary

Modifier and Type	Method and Description
static QueryResult	ccpXmlToQueryResult(String xml) Deserialize a CCP query result from XML.
static Error	convertCcpErrorToCommonError(Error ccpError) Transforms a CCP Error to a common Error.
static Query	convertCcpQueryToCommonQuery(Query ccpQuery) Transforms a CCP Query to a common Query.
static View	convertCcpViewToCommonView(View ccpView) Transforms a CCP View to a common View.
static Error	convertCommonErrorToCcpError(Error commonError) Transforms a Common Error to a CCP Error.
static Error	convertCommonErrorToOsseError(Error commonError) Transforms a common Error to an OSSE Error.
static QueryResultStatistic	convertCommonQrsToOsseQrs(QueryResultStatistic commonQueryResultStatistic) Transforms a common QueryResultStatistic to an OSSE QueryResultStatistic.
static Query	convertCommonQueryToCcpQuery(Query commonQuery) Transforms a Common Query to a CCP Query.
static Query	convertCommonQueryToOsseQuery(Query commonQuery) Transforms a common Query to an OSSE Query.
static View	convertCommonViewToCcpView(View commonView) Transforms a Common View to a CCP View.
static View	convertCommonViewToOsseView(View commonView) Transforms a common View to an OSSE View.
static Error	convertOsseErrorToCommonError(Error osseError) Transforms an OSSE Error to a common Error.
static QueryResultStatistic	convertOsseQueryResultStatisticToCommonQueryResult(QueryResultStatistic osseQueryResultStatistic) Transforms an OSSE QueryResultStatistic to a common QueryResultStatistic.
static Query	convertOsseQueryToCommonQuery(Query osseQuery) Transforms an OSSE Query to a common Query.
static View	convertOsseViewToCommonView(View osseView) Transforms an OSSE View to a common View.
static Query	insertRootGroup(Query oldQuery) Insert an "AND" conjunction group as first child of the Where - if there is no "AND" or "OR" yet.
static <T> String	marshal(T object, JAXBContext context) Marshal an object to xml.
static QueryResult	osseXmlToQueryResult(String xml) Deserialize an OSSE query result from XML.
static String	queryToXml(Query query) Serialize a query to XML.
static Query	removeAttributesFromQuery(Query query, List<String> attributes) Remove any given attribute from the query.
static View	removeAttributesFromView(View view, List<String> attributes) Removes all provided attributes (and their parent nodes if necessary) from a view.
static void	removeEmptyNodes(Node node) Removes the empty nodes below a given node.
static Query	substituteOperators(Query query) Currently, Centraxx does not know of the "between" and "in" operators.
static <T> T	unmarshal(String xml, JAXBContext context, Class<T> clazz) Unmarshal an object from xml.
static String	viewToXml(View view) Serialize a view to XML.
static String	viewToXml(View view)
static Query	xmlToQuery(String xml) Deserialize a common query from XML.
static View	xmlToView(String xml) Deserialize a common view from XML.

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final org.slf4j.Logger logger

XMLNS_PATH_COMMON

public static final String XMLNS_PATH_COMMON

See Also:

Constant Field Values

XMLNS_PATH_CCP

public static final String XMLNS_PATH_CCP

See Also:

Constant Field Values

XMLNS_PATH_OSSE

public static final String XMLNS_PATH_OSSE

See Also:

Constant Field Values

Method Detail

unmarshal

public static <T> T unmarshal(String xml,
                              JAXBContext context,
                              Class<T> clazz)
                       throws JAXBException

Unmarshal an object from xml.

Type Parameters:

T - the target type

Parameters:

xml - the source xml string

context - the jaxb context

clazz - the target class

Returns:

the target object

Throws:

JAXBException

marshal

public static <T> String marshal(T object,
                                 JAXBContext context)

Marshal an object to xml.

Type Parameters:

T - the type of the object to marshal

Parameters:

object - the object to marshal

context - the jaxb context, which has to be initalized with the correct class

Returns:

the marshalled object

convertCcpQueryToCommonQuery

public static Query convertCcpQueryToCommonQuery(Query ccpQuery)
                                          throws JAXBException

Transforms a CCP Query to a common Query. Is used to transform queries that are transmitted via REST interface from central search.

Parameters:

ccpQuery - the query in the ccp namespace

Returns:

XML the query in the common namespace

Throws:

JAXBException

convertOsseQueryToCommonQuery

public static Query convertOsseQueryToCommonQuery(Query osseQuery)
                                           throws JAXBException

Transforms an OSSE Query to a common Query.

Parameters:

osseQuery - the query in the osse namespace

Returns:

XML the query in the common namespace

Throws:

JAXBException

convertCommonQueryToCcpQuery

public static Query convertCommonQueryToCcpQuery(Query commonQuery)
                                          throws JAXBException

Transforms a Common Query to a CCP Query.

Parameters:

commonQuery - the query in the common namespace

Returns:

XML the query in the ccp namespace

Throws:

JAXBException

convertCommonQueryToOsseQuery

public static Query convertCommonQueryToOsseQuery(Query commonQuery)
                                           throws JAXBException

Transforms a common Query to an OSSE Query.

Parameters:

commonQuery - the query in the common namespace

Returns:

XML the query in the osse namespace

Throws:

JAXBException

convertCcpViewToCommonView

public static View convertCcpViewToCommonView(View ccpView)
                                       throws JAXBException

Transforms a CCP View to a common View. Is used to transform queries that are transmitted via REST interface from central search

Parameters:

ccpView - the view in the ccp namespace

Returns:

XML the view in the common namespace

Throws:

JAXBException

convertOsseViewToCommonView

public static View convertOsseViewToCommonView(View osseView)
                                        throws JAXBException

Transforms an OSSE View to a common View.

Parameters:

osseView - the view in the osse namespace

Returns:

XML the view in the common namespace

Throws:

JAXBException

convertCommonViewToCcpView

public static View convertCommonViewToCcpView(View commonView)
                                       throws JAXBException

Transforms a Common View to a CCP View.

Parameters:

commonView - the view in the common namespace

Returns:

XML the view in the ccp namespace

Throws:

JAXBException

convertCommonViewToOsseView

public static View convertCommonViewToOsseView(View commonView)
                                        throws JAXBException

Transforms a common View to an OSSE View.

Parameters:

commonView - the view in the common namespace

Returns:

XML the view in the osse namespace

Throws:

JAXBException

convertCcpErrorToCommonError

public static Error convertCcpErrorToCommonError(Error ccpError)
                                          throws JAXBException

Transforms a CCP Error to a common Error. Is used to transform queries that are transmitted via REST interface from central search

Parameters:

ccpError - the error in the ccp namespace

Returns:

XML the error in the common namespace

Throws:

JAXBException

convertOsseErrorToCommonError

public static Error convertOsseErrorToCommonError(Error osseError)
                                           throws JAXBException

Transforms an OSSE Error to a common Error.

Parameters:

osseError - the error in the osse namespace

Returns:

XML the error in the common namespace

Throws:

JAXBException

convertCommonErrorToCcpError

public static Error convertCommonErrorToCcpError(Error commonError)
                                          throws JAXBException

Transforms a Common Error to a CCP Error.

Parameters:

commonError - the error in the common namespace

Returns:

XML the error in the ccp namespace

Throws:

JAXBException

convertCommonErrorToOsseError

public static Error convertCommonErrorToOsseError(Error commonError)
                                           throws JAXBException

Transforms a common Error to an OSSE Error.

Parameters:

commonError - the error in the common namespace

Returns:

XML the error in the osse namespace

Throws:

JAXBException

convertOsseQueryResultStatisticToCommonQueryResult

public static QueryResultStatistic convertOsseQueryResultStatisticToCommonQueryResult(QueryResultStatistic osseQueryResultStatistic)
                                                                               throws JAXBException

Transforms an OSSE QueryResultStatistic to a common QueryResultStatistic.

Parameters:

osseQueryResultStatistic - the QueryResultStatistic in the osse namespace

Returns:

the QueryResultStatistic in the common namespace

Throws:

JAXBException

convertCommonQrsToOsseQrs

public static QueryResultStatistic convertCommonQrsToOsseQrs(QueryResultStatistic commonQueryResultStatistic)
                                                      throws JAXBException

Transforms a common QueryResultStatistic to an OSSE QueryResultStatistic.

Parameters:

commonQueryResultStatistic - the QueryResultStatistic in the common namespace

Returns:

the QueryResultStatistic in the osse namespace

Throws:

JAXBException

queryToXml

public static String queryToXml(Query query)
                         throws JAXBException

Serialize a query to XML.

Parameters:

query - the query

Returns:

the XML formatted query

Throws:

JAXBException

xmlToQuery

public static Query xmlToQuery(String xml)
                        throws JAXBException

Deserialize a common query from XML.

Parameters:

xml - the query in XML representation

Returns:

the query object

Throws:

JAXBException

viewToXml

public static String viewToXml(View view)
                        throws JAXBException

Serialize a view to XML.

Parameters:

view - the View to be serialized

Returns:

XML representation of the view

Throws:

JAXBException

viewToXml

public static String viewToXml(View view)
                        throws JAXBException

Throws:

JAXBException

xmlToView

public static View xmlToView(String xml)
                      throws JAXBException

Deserialize a common view from XML.

Parameters:

xml - XML representation of the view

Returns:

the view object

Throws:

JAXBException

ccpXmlToQueryResult

public static QueryResult ccpXmlToQueryResult(String xml)
                                       throws JAXBException

Deserialize a CCP query result from XML.

Parameters:

xml - XML representation of the query result

Returns:

the query result object

Throws:

JAXBException

osseXmlToQueryResult

public static QueryResult osseXmlToQueryResult(String xml)
                                        throws JAXBException

Deserialize an OSSE query result from XML.

Parameters:

xml - XML representation of the query result

Returns:

the query result object

Throws:

JAXBException

insertRootGroup

public static Query insertRootGroup(Query oldQuery)

Insert an "AND" conjunction group as first child of the Where - if there is no "AND" or "OR" yet.

Parameters:

oldQuery - the query to modify

Returns:

the query with an AND as first child of the where

substituteOperators

public static Query substituteOperators(Query query)

Currently, Centraxx does not know of the "between" and "in" operators. Replace Between with an "and"-combination of geq and leq Replace In with an "or"-combination of eq.

Parameters:

query - the original query

Returns:

the query with the replacements

removeAttributesFromView

public static View removeAttributesFromView(View view,
                                            List<String> attributes)

Removes all provided attributes (and their parent nodes if necessary) from a view.

Parameters:

view - the view

attributes - the attributes to remove

Returns:

the view

removeAttributesFromQuery

public static Query removeAttributesFromQuery(Query query,
                                              List<String> attributes)

Remove any given attribute from the query.

Parameters:

query - the query in which the attributes shall be removed

attributes - a list of attributes to remove

Returns:

the query without the attributes in the provided list

removeEmptyNodes

public static void removeEmptyNodes(Node node)

Removes the empty nodes below a given node.

Parameters:

node - the rootnode