org.dd4t.providers

Interface QueryProvider

public interface QueryProvider

QueryProvider. Interface for doing Broker look ups. Currently provides only the basic stuff.

TODO: add methods to query custom meta for normal CPs

Author:

R. Kempees

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getDynamicComponentPresentationsByCustomMetaQuery(String locale, Map<String,Collection<String>> keyValueMap, int templateId) Retrieves content of a Dynamic Component Presentation by looking up its locale and keyValueMap The returned content can for instance represent multiple Component Strings separated by |.
String[]	getDynamicComponentPresentationsBySchema(String locale, String schema, int templateId) Retrieves content of a Dynamic Component Presentation by doing a Broker Query based on Schema Criteria.
String[]	getDynamicComponentPresentationsBySchemaInKeyword(String locale, String schema, int categoryId, int keywordId, int templateId) Retrieves content of a Dynamic Component Presentation by doing an AND Broker Query based on Schema and Keyword Criteria.

Method Detail

getDynamicComponentPresentationsByCustomMetaQuery

String[] getDynamicComponentPresentationsByCustomMetaQuery(String locale,
                                                         Map<String,Collection<String>> keyValueMap,
                                                         int templateId)
                                                           throws ItemNotFoundException,
                                                                  SerializationException

Retrieves content of a Dynamic Component Presentation by looking up its locale and keyValueMap The returned content can for instance represent multiple Component Strings separated by |.

The KeyValueMap can hold 0 or more CUSTOM_META criteria

Parameters:

locale - String representing the locale to be queried, for e.g.: en_gb

keyValueMap - A Map representing the Key Value pairs to insert as Meta Filters

Returns:

String representing the content of the CP (s)

Throws:

ItemNotFoundException - if the requested CP does not exist

SerializationException - if something went wrong during deserialization

getDynamicComponentPresentationsBySchema

String[] getDynamicComponentPresentationsBySchema(String locale,
                                                String schema,
                                                int templateId)
                                                  throws ItemNotFoundException,
                                                         SerializationException

Retrieves content of a Dynamic Component Presentation by doing a Broker Query based on Schema Criteria. If the templateId is set, only components published with that templateId are returned.

Note that doing a direct Broker query is significantly faster than using the TaxonomyProvider.

The returned content can for instance represent multiple Component Strings separated by |.

Parameters:

locale - The locale, to be translated to a publication Id

schema - The title of the schema

templateId - The Component template Id of CPs to return

Returns:

String representing the content of the CP(s)

Throws:

ItemNotFoundException

SerializationException

getDynamicComponentPresentationsBySchemaInKeyword

String[] getDynamicComponentPresentationsBySchemaInKeyword(String locale,
                                                         String schema,
                                                         int categoryId,
                                                         int keywordId,
                                                         int templateId)
                                                           throws ItemNotFoundException,
                                                                  SerializationException

Retrieves content of a Dynamic Component Presentation by doing an AND Broker Query based on Schema and Keyword Criteria. If the templateId is set, only components published with that templateId are returned.

Note that doing a direct Broker query is significantly faster than using the TaxonomyProvider.

The returned content can for instance represent multiple Component Strings separated by |.

Parameters:

locale - The locale, to be translated to a publication Id

schema - The title of the schema

categoryId - The Item Id of the category

keywordId - The Item Id of the keyword

templateId - The Component template Id of CPs to return

Returns:

String representing the content of the CP(s)

Throws:

ItemNotFoundException

SerializationException