Este documento describe cómo extender Solr mediante la implementación de componentes de búsqueda y transformadores de documentos. Explica cómo crear un componente de búsqueda para limitar el número máximo de documentos devueltos y cómo crear un transformador de documentos para añadir o quitar campos de la respuesta antes de la serialización. También cubre conceptos como parámetros de configuración, excepciones Solr y la inicialización de componentes.

1. !
ExtendiendoSolr

2. Search Update
SolrRequestHandler
SearchComponents
UpdateHandler
UpdateProcessors
Dispatcher
DocTransformers
QueryResponseWriter
SolrCache QParser
schema.xml
solrconfig.xml
Response
Text Analysis
Index
Query
Lucene Index
Query
ValueSource
Parser
!"
Directory
Factory
Codec
Factory
Index
Schema
FactoryTokenFilter MergePolicy
MergePolicy
Cache
Regenerator
Ilustration by Jorge Luis Betancourt González
You may freely use it as long as you attribute to the author, to the CC-by license
www.creativecommons.org
QParserPlugin

3. Elproyecto

4. Libreríasnecesarias…
solr-core-*
solr-solrj-*
solr/dist/
slf4j-api-*
solr/dist/
solrj-lib

5. example/solr-webapp/webapp/WEB-INF/lib
lucene-core-*

6. SearchComponent

7. Ejecutaralgunalógicadeterminada
duranteelprocesodebúsqueda,puede
serantesdelaejecucióndelaqueryo
despuéssobreelresultadodelaquery.

8. Todosloscomponentesnecesitan
heredardelaclaseabstracta
!
SearchComponent
!
delpaquete
org.apache.solr.handler.component

9. public void prepare(ResponseBuilder rb)
Preparalarespuesta,segarantizaquesellamaantes
queelmétodoprocess()decualquierotro
SearchComponent.
public void process(ResponseBuilder rb)
Ejecutalalógicadeprocesadoparaestecomponente.

10. public String getSource();
Métododeayudadevuelveelnombredelarchivoque
implementaelcomponente,ej.:
cu.orion.MaxParameters
public String getDescription();
Devuelveunabrevedescripciónsobreloquedebehacer
elmétodo,utilizadoparadebug.

11. Parámetrosdeconfiguración
<searchComponent name="max-parameters"
class="orion.MaxParamsSearchComponent">
<str name="rows">10</str>
<str name="start">2</str>
</searchComponent>
parámetrosdeconfiguración
delcomponente

12. public void init( NamedList args )
Estemétodotieneaccesoalosparámetrosde
configuracióndefinidosenelarchivo
solrconfig.xml
public void init(NamedList args) {
if (null != args) {
SolrParams params =
SolrParams.toSolrParams(args);
}
}

13. SolrParams
public Boolean getBool(String param,
boolean def)
public int getInt(String param,
int def)
public float getFloat(String param,
float def)
public double getDouble(String param,
double def)
public String get(String param,
String def)

14. maxRowsParam = params.getInt("rows", -1);
!
maxStartParam = params.getInt("start", -1)
llave/nombre
valorpor
defecto

15. Implementaruncomponentequeno
permitapedirmásdeunnúmeroNde
documentosencadapetición.

16. demo

17. mkdir -p solr/collection1/lib
Copiarel.jardesdeeldirectoriode
compilacióndenuestroproyectohacia:
!
solr/collection1/lib

18. <searchComponent name="max-parameters"
class="cu.uci.solr.MaxSearchComponent">
<str name="rows">10</str>
<str name="start">2</str>
</searchComponent>
<arr name="first-components">
<str>max-parameters</str>
</arr>

19. <response>
<lst name="responseHeader">
<int name="status">400</int>
<int name="QTime">19</int>
</lst>
<lst name="error">
<str name="msg">
Your start or rows parameter has
exceeded the allowed values
</str>
<int name="code">400</int>
</lst>
</response>
/select?q=*:*&rows=200

20. ExcepcionesdeSolrException
public enum ErrorCode {
BAD_REQUEST( 400 ),
UNAUTHORIZED( 401 ),
FORBIDDEN( 403 ),
NOT_FOUND( 404 ),
SERVER_ERROR( 500 ),
SERVICE_UNAVAILABLE( 503 ),
UNKNOWN(0);
}
Estoscódigossonequivalentesalos
códigosHTTPyavistos.

21. throw new SolrException(
SolrException.ErrorCode.BAD_REQUEST,
"Your start or rows parameter has
exceeded the allowed values");

22. curl --head http://localhost:8983/solr/
collection1/select?q=*:*&rows=200
HTTP/1.1 400 Bad Request
Cache-Control: no-cache, no-store
Pragma: no-cache
Expires: Sat, 01 Jan 2000 01:00:00 GMT
Last-Modified: Mon, 29 Sep 2014 02:10:56 GMT
ETag: "148bf2cc9d6"
Content-Type: application/xml; charset=UTF-8
Content-Length: 0

23. DocTransformers

24. Nospermiteañadir/quitarcamposdela
respuestaqueseenvíaalclientejusto
antesdeserserializada.Sepuedeañadir
oremovercamposindependientemente
delparámetrofl.

25. ParacrearunDocTransformerse
necesitan2clases
MyDocTransformer
MyDocTransformerFactory

26. MyDocTransformerFactory
TransformerFactory
MyDocTransformer
DocTransformer

27. public DocTransformer create(
String field, SolrParams params,
SolrQueryRequest req)
Factory
public void init(NamedList args)
métodoresponsabledecrearunainstancia
delDocTransformer

28. public String getName()
DocTransformer
public void transform(
SolrDocument doc,
int docid)
añade/quitacamposdelainstanciade
SolrDocument

29. demo

30. <transformer name="mytrans2"
class="my.transform.MyDocTransformerFactory">
<int name="value">5</int>
</transformer>
/select?q=*:*fl=[name]
solrconfig.xml
getName()