org.nuiton.wikitty.query

Class WikittyQueryResult<T>

java.lang.Object

org.nuiton.wikitty.query.WikittyQueryResult<T>

All Implemented Interfaces:

Serializable, Iterable<T>

public class WikittyQueryResult<T>
extends Object
implements Serializable, Iterable<T>

Represente un resultat de requete WikittyQuery. Pour caster les valeurs dans une autre representation vous pouvez utiliser la methode WikittyClient.castTo(java.lang.Class, org.nuiton.wikitty.query.WikittyQueryResult)

Since:

3.3 Last update: $Date: 2013-02-25 01:57:54 +0100 (Mon, 25 Feb 2013) $ by : $Author: bpoussin $

Version:

$Revision: 1554 $

Author:

poussin

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,List<FacetTopic>>	facets facet asked or null if no facet
protected Map<String,Map<String,FacetTopic>>	facetsAsMap facet asked of null if no facet, FacetTopic are put in map with key topic name, To use this variable, you must used getter, because, this variable is lazy loaded from facets variable.
protected int	offset indice of offset result in global search result
protected WikittyQuery	query query used to produce initial WikittyQueryResult
protected String	queryName nom du critere qui a ete uitilise (peut-etre null) si le critete n'avait pas de nom
protected String	queryString query really executed (internal representation depend of search engine used
protected List<T>	results list of result in the wanted interval
protected List<Map<String,Object>>	selectResult if query contains select clause, contains select result
protected long	timeConvertion temps (nanoseconde) de transformation des resultats bruts en un autre type(calcul cote client)
protected long	timeQuery temps (nanoseconde) mis pour faire la requete (calcul cote serveur)
protected int	totalResult total number of result if we call the query for all possible result
protected List<String>	wikittyIdResult Wikitty ids resulting of where clause

Constructor Summary

Constructors

Constructor and Description
WikittyQueryResult(String queryName, int offset, int totalResult, WikittyQuery query, String queryString, List<T> results, List<Map<String,Object>> selectResult, List<String> wikittyIdResult, Map<String,List<FacetTopic>> facets, long timeQuery, long timeConvertion) Init paged result.

Method Summary

Methods

Modifier and Type	Method and Description
<E> WikittyQueryResult<E>	castTo(WikittyClient client, Class<E> target) Convert all result to the wanted type and return new WikittyQueryResult with this new result list.
<E,F> WikittyQueryResult<Map<String,E>>	castToMap(WikittyClient client, Class<E> target) Convert all result to the wanted type and return new WikittyQueryResult with this new result list.
<E> WikittyQueryResult<E>	convertMapToSimple() if this WikittyQueryResult contains Map, and each Map contains only one value, this methode return new WikittyQueryResult with value only (no more map).
WikittyQueryResult<String>	convertMapToSimpleString()
T	get(int i) Return element at index.
List<T>	getAll() Return unmodifiable list of all result.
Collection<String>	getFacetNames() Return name of all facet used in query.
Map<String,List<FacetTopic>>	getFacets() Get map represent facets.
Map<String,Map<String,FacetTopic>>	getFacetsAsMap() Get map represent facets.
int	getFirst() Deprecated. since 3.5 use getOffset()
int	getOffset() indice of offset result in global search result
WikittyQuery	getQuery() Return query used to initialise the first WikittyQueryResult (before some transformation with getSelect or getWikitties).
String	getQueryName() nom du critere qui a ete uitilise (peut-etre null) si le critete n'avait pas de nom
String	getQueryString() query really executed (internal representation depend of search engine used
WikittyQueryResult<Map<String,Object>>	getSelectResult() Retourne les resultats de select
WikittyQueryResult<Object>	getSelectResult(String resultName) Retourne les resultats de select pour le champs demande
<E> WikittyQueryResult<Map<String,E>>	getSelectResult(WikittyClient client, Class<E> clazz) Retourne les resultats de select transforme en objet de type clazz
<E> WikittyQueryResult<E>	getSelectResult(WikittyClient client, Class<E> clazz, String resultName) Retourne les resultats de select pour le champs demande et le transforme en objet de type clazz
List<String>	getSelectResultName() Retourne la liste liste des noms disponible comme resulat de select
long	getTimeConvertion() temps (nanoseconde) de transformation des resultats bruts en un autre type(calcul cote client)
long	getTimeQuery() temps (nanoseconde) mis pour faire la requete (calcul cote serveur)
List<FacetTopic>	getTopic(Element facetName) Return all topic for the specified facet.
List<FacetTopic>	getTopic(String facetName) Return all topic for the specified facet.
FacetTopic	getTopic(String facetName, String topicName) Return topic for the specified facet and topic name.
int	getTopicCount(String facetName, String topicName) Return topic count for the specified facet and topic name.
int	getTotalResult() total number of result if we call the query for all possible result
WikittyQueryResult<String>	getWikittyResult() Retourne un nouveau WikittyQueryResult avec comme resultat la liste des ids des wikitties selectionnes par la Query initiale
<E extends BusinessEntity> WikittyQueryResult<E>	getWikittyResult(WikittyClient client, Class<E> clazz) Retourne un nouveau WikittyQueryResult avec comme resultat une liste de BusinessEntity du type de la class passee en parametre a partir des ids des wikitties selectionnes par la Query initiale
int	getWikittyResultSize() retourne le nombre de wikitty actuellement disponible dans le resultat
boolean	hasSelectResult() Indique s'il y a des resultats de select on non
Iterator<T>	iterator() Iterate on result, same as getAll().iterator().
T	peek() Return the offset element in result Can throw an exception if no element available
int	selectResultSize() Le nombre de map contenu dans le resultat de select
void	setTimeConvertion(long timeConvertion) temps (nanoseconde) de transformation des resultats bruts en un autre type(calcul cote client)
void	setTimeQuery(long timeQuery) temps (nanoseconde) mis pour faire la requete (calcul cote serveur)
int	size() Return the number of result in this object.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

queryName

protected String queryName

nom du critere qui a ete uitilise (peut-etre null) si le critete n'avait pas de nom

offset

protected int offset

indice of offset result in global search result

totalResult

protected int totalResult

total number of result if we call the query for all possible result

queryString

protected String queryString

query really executed (internal representation depend of search engine used

query

protected WikittyQuery query

query used to produce initial WikittyQueryResult

results

protected List<T> results

list of result in the wanted interval

wikittyIdResult

protected List<String> wikittyIdResult

Wikitty ids resulting of where clause

selectResult

protected List<Map<String,Object>> selectResult

if query contains select clause, contains select result

facets

protected Map<String,List<FacetTopic>> facets

facet asked or null if no facet

facetsAsMap

protected transient Map<String,Map<String,FacetTopic>> facetsAsMap

facet asked of null if no facet, FacetTopic are put in map with key topic name, To use this variable, you must used getter, because, this variable is lazy loaded from facets variable.

timeQuery

protected long timeQuery

temps (nanoseconde) mis pour faire la requete (calcul cote serveur)

timeConvertion

protected long timeConvertion

temps (nanoseconde) de transformation des resultats bruts en un autre type(calcul cote client)

Constructor Detail

WikittyQueryResult

public WikittyQueryResult(String queryName,
                  int offset,
                  int totalResult,
                  WikittyQuery query,
                  String queryString,
                  List<T> results,
                  List<Map<String,Object>> selectResult,
                  List<String> wikittyIdResult,
                  Map<String,List<FacetTopic>> facets,
                  long timeQuery,
                  long timeConvertion)

Init paged result. we don't initialize securityToken

Parameters:

offset - indice element in global search result

totalResult - total number of result if we call the query for all possible result

queryString - query really executed

facets - facet asked or null if no facet

results - list of result in the wanted interval

Method Detail

convertMapToSimple

public <E> WikittyQueryResult<E> convertMapToSimple()

if this WikittyQueryResult contains Map, and each Map contains only one value, this methode return new WikittyQueryResult with value only (no more map). If this WikittyQueryResult don't contains Map, then this is returned

Returns:

convertMapToSimpleString

public WikittyQueryResult<String> convertMapToSimpleString()

getQueryName

public String getQueryName()

nom du critere qui a ete uitilise (peut-etre null) si le critete n'avait pas de nom

getFirst

@Deprecated
public int getFirst()

Deprecated. since 3.5 use getOffset()

getOffset

public int getOffset()

indice of offset result in global search result

getTotalResult

public int getTotalResult()

total number of result if we call the query for all possible result

getQueryString

public String getQueryString()

query really executed (internal representation depend of search engine used

getQuery

public WikittyQuery getQuery()

Return query used to initialise the first WikittyQueryResult (before some transformation with getSelect or getWikitties). This query is query realy send to server after some modification by WikittyClient if necessary

Returns:

Since:

3.10

getWikittyResultSize

public int getWikittyResultSize()

retourne le nombre de wikitty actuellement disponible dans le resultat

Returns:

Since:

3.10

getWikittyResult

public WikittyQueryResult<String> getWikittyResult()

Retourne un nouveau WikittyQueryResult avec comme resultat la liste des ids des wikitties selectionnes par la Query initiale

Returns:

Since:

3.10

getWikittyResult

public <E extends BusinessEntity> WikittyQueryResult<E> getWikittyResult(WikittyClient client,
                                                                Class<E> clazz)

Retourne un nouveau WikittyQueryResult avec comme resultat une liste de BusinessEntity du type de la class passee en parametre a partir des ids des wikitties selectionnes par la Query initiale

Returns:

Since:

3.10

hasSelectResult

public boolean hasSelectResult()

Indique s'il y a des resultats de select on non

Returns:

Since:

3.10

selectResultSize

public int selectResultSize()

Le nombre de map contenu dans le resultat de select

Returns:

Since:

3.10

getSelectResultName

public List<String> getSelectResultName()

Retourne la liste liste des noms disponible comme resulat de select

Returns:

Since:

3.10

getSelectResult

public WikittyQueryResult<Map<String,Object>> getSelectResult()

Retourne les resultats de select

Returns:

Since:

3.10

getSelectResult

public <E> WikittyQueryResult<Map<String,E>> getSelectResult(WikittyClient client,
                                                    Class<E> clazz)

Retourne les resultats de select transforme en objet de type clazz

Type Parameters:

E -

Parameters:

client -

clazz -

Returns:

Since:

3.10

getSelectResult

public WikittyQueryResult<Object> getSelectResult(String resultName)

Retourne les resultats de select pour le champs demande

Parameters:

resultName -

Returns:

Since:

3.10

getSelectResult

public <E> WikittyQueryResult<E> getSelectResult(WikittyClient client,
                                        Class<E> clazz,
                                        String resultName)

Retourne les resultats de select pour le champs demande et le transforme en objet de type clazz

Parameters:

resultName -

Returns:

Since:

3.10

getFacetNames

public Collection<String> getFacetNames()

Return name of all facet used in query.

Returns:

result's facets names

getTopic

public List<FacetTopic> getTopic(String facetName)

Return all topic for the specified facet.

Parameters:

facetName - name of the wanted facet

Returns:

facet's topics

getTopic

public List<FacetTopic> getTopic(Element facetName)

Return all topic for the specified facet.

Parameters:

facetName - name of the wanted facet

Returns:

facet's topics

Since:

3.4

getTopic

public FacetTopic getTopic(String facetName,
                  String topicName)

Return topic for the specified facet and topic name.

Parameters:

facetName - name of the wanted facet

topicName - name of the wanted topic

Returns:

topic

getTopicCount

public int getTopicCount(String facetName,
                String topicName)

Return topic count for the specified facet and topic name. If facet or topic don't exist, return 0.

Parameters:

facetName - name of the wanted facet

topicName - name of the wanted topic

Returns:

topic count or 0

getFacets

public Map<String,List<FacetTopic>> getFacets()

Get map represent facets. return map of list

key is facet name value is topic liste une this facet

Returns:

all facets

getFacetsAsMap

public Map<String,Map<String,FacetTopic>> getFacetsAsMap()

Get map represent facets. return map of map

primary key is facet name secondary key is topic name value is topic