org.apache.solr.handler.admin

Class LukeRequestHandler

java.lang.Object

org.apache.solr.handler.RequestHandlerBase

org.apache.solr.handler.admin.LukeRequestHandler

All Implemented Interfaces:

SolrInfoMBean, SolrRequestHandler

public class LukeRequestHandler
extends RequestHandlerBase

This handler exposes the internal lucene index. It is inspired by and modeled on Luke, the Lucene Index Browser by Andrzej Bialecki. http://www.getopt.org/luke/

NOTE: the response format is still likely to change. It should be designed so that it works nicely with an XSLT transformation. Until we have a nice XSLT front end for /admin, the format is still open to change.

For more documentation see: http://wiki.apache.org/solr/LukeRequestHandler

Since:

solr 1.2

Version:

$Id: LukeRequestHandler.java 1242152 2012-02-08 22:31:07Z erick $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	LukeRequestHandler.TermHistogram
private static class	LukeRequestHandler.TopTermQueue Private internal class that counts up frequent terms

Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoMBean

SolrInfoMBean.Category

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COUNT
static java.lang.String	DOC_ID
(package private) static int	HIST_ARRAY_SIZE
static java.lang.String	ID
private static org.slf4j.Logger	log
static java.lang.String	NUMTERMS
static java.lang.String	REPORT_DOC_COUNT

Fields inherited from class org.apache.solr.handler.RequestHandlerBase

appends, defaults, httpCaching, initArgs, invariants

Constructor Summary

Constructors

Constructor and Description
LukeRequestHandler()

Method Summary

Modifier and Type	Method and Description
private static SimpleOrderedMap<java.lang.Object>	getAnalyzerInfo(org.apache.lucene.analysis.Analyzer analyzer)
java.lang.String	getDescription() Simple one or two line description
java.net.URL[]	getDocs() Documentation URL list.
private static SimpleOrderedMap<java.lang.Object>	getDocumentFieldsInfo(org.apache.lucene.document.Document doc, int docId, org.apache.lucene.index.IndexReader reader, IndexSchema schema)
private static java.lang.String	getFieldFlags(org.apache.lucene.document.Fieldable f)
private static java.lang.String	getFieldFlags(SchemaField f)
static SimpleOrderedMap<java.lang.String>	getFieldFlagsKey()
private static SimpleOrderedMap<java.lang.Object>	getIndexedFieldsInfo(SolrIndexSearcher searcher, java.util.Set<java.lang.String> fields, int numTerms, java.util.Map<java.lang.String,LukeRequestHandler.TopTermQueue> ttinfo, boolean reportDocCount)
static SimpleOrderedMap<java.lang.Object>	getIndexInfo(org.apache.lucene.index.IndexReader reader, boolean countTerms)
static SimpleOrderedMap<java.lang.Object>	getIndexInfo(org.apache.lucene.index.IndexReader reader, int numTerms, java.util.Map<java.lang.String,LukeRequestHandler.TopTermQueue> topTerms, java.util.Set<java.lang.String> fields)
private static SimpleOrderedMap<java.lang.Object>	getSchemaInfo(IndexSchema schema) Return info from the index
java.lang.String	getSource() CVS Source, SVN Source, etc
java.lang.String	getSourceId() CVS Id, SVN Id, etc
java.lang.String	getVersion() Simple common usage version, e.g.
void	handleRequestBody(SolrQueryRequest req, SolrQueryResponse rsp)
private static void	populateFieldInfo(IndexSchema schema, java.util.Map<java.lang.String,java.util.List<java.lang.String>> typeusemap, java.util.Map<java.lang.String,java.lang.Object> fields, SchemaField uniqueField, SchemaField f)

Methods inherited from class org.apache.solr.handler.RequestHandlerBase

getCategory, getInitArgs, getName, getStatistics, handleRequest, init

Methods inherited from class java.lang.Object

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

Field Detail

log

private static org.slf4j.Logger log

NUMTERMS

public static final java.lang.String NUMTERMS

See Also:

Constant Field Values

DOC_ID

public static final java.lang.String DOC_ID

See Also:

Constant Field Values

ID

public static final java.lang.String ID

See Also:

Constant Field Values

REPORT_DOC_COUNT

public static final java.lang.String REPORT_DOC_COUNT

See Also:

Constant Field Values

DEFAULT_COUNT

public static final int DEFAULT_COUNT

See Also:

Constant Field Values

HIST_ARRAY_SIZE

static final int HIST_ARRAY_SIZE

See Also:

Constant Field Values

Constructor Detail

LukeRequestHandler

public LukeRequestHandler()

Method Detail

handleRequestBody

public void handleRequestBody(SolrQueryRequest req,
                              SolrQueryResponse rsp)
                       throws java.lang.Exception

Specified by:

handleRequestBody in class RequestHandlerBase

Throws:

java.lang.Exception

getFieldFlags

private static java.lang.String getFieldFlags(org.apache.lucene.document.Fieldable f)

Returns:

a string representing a Fieldable's flags.

getFieldFlags

private static java.lang.String getFieldFlags(SchemaField f)

Returns:

a string representing a SchemaField's flags.

getFieldFlagsKey

public static SimpleOrderedMap<java.lang.String> getFieldFlagsKey()

Returns:

a key to what each character means

getDocumentFieldsInfo

private static SimpleOrderedMap<java.lang.Object> getDocumentFieldsInfo(org.apache.lucene.document.Document doc,
                                                                        int docId,
                                                                        org.apache.lucene.index.IndexReader reader,
                                                                        IndexSchema schema)
                                                                 throws java.io.IOException

Throws:

java.io.IOException

getIndexedFieldsInfo

private static SimpleOrderedMap<java.lang.Object> getIndexedFieldsInfo(SolrIndexSearcher searcher,
                                                                       java.util.Set<java.lang.String> fields,
                                                                       int numTerms,
                                                                       java.util.Map<java.lang.String,LukeRequestHandler.TopTermQueue> ttinfo,
                                                                       boolean reportDocCount)
                                                                throws java.lang.Exception

Throws:

java.lang.Exception

getSchemaInfo

private static SimpleOrderedMap<java.lang.Object> getSchemaInfo(IndexSchema schema)

Return info from the index

getAnalyzerInfo

private static SimpleOrderedMap<java.lang.Object> getAnalyzerInfo(org.apache.lucene.analysis.Analyzer analyzer)

populateFieldInfo

private static void populateFieldInfo(IndexSchema schema,
                                      java.util.Map<java.lang.String,java.util.List<java.lang.String>> typeusemap,
                                      java.util.Map<java.lang.String,java.lang.Object> fields,
                                      SchemaField uniqueField,
                                      SchemaField f)

getIndexInfo

public static SimpleOrderedMap<java.lang.Object> getIndexInfo(org.apache.lucene.index.IndexReader reader,
                                                              boolean countTerms)
                                                       throws java.io.IOException

Throws:

java.io.IOException

getIndexInfo

public static SimpleOrderedMap<java.lang.Object> getIndexInfo(org.apache.lucene.index.IndexReader reader,
                                                              int numTerms,
                                                              java.util.Map<java.lang.String,LukeRequestHandler.TopTermQueue> topTerms,
                                                              java.util.Set<java.lang.String> fields)
                                                       throws java.io.IOException

Throws:

java.io.IOException

getDescription

public java.lang.String getDescription()

Description copied from interface: SolrInfoMBean

Simple one or two line description

Specified by:

getDescription in interface SolrInfoMBean

Specified by:

getDescription in class RequestHandlerBase

getVersion

public java.lang.String getVersion()

Description copied from interface: SolrInfoMBean

Simple common usage version, e.g. 2.0

Specified by:

getVersion in interface SolrInfoMBean

Specified by:

getVersion in class RequestHandlerBase

getSourceId

public java.lang.String getSourceId()

Description copied from interface: SolrInfoMBean

CVS Id, SVN Id, etc

Specified by:

getSourceId in interface SolrInfoMBean

Specified by:

getSourceId in class RequestHandlerBase

getSource

public java.lang.String getSource()

Description copied from interface: SolrInfoMBean

CVS Source, SVN Source, etc

Specified by:

getSource in interface SolrInfoMBean

Specified by:

getSource in class RequestHandlerBase

getDocs

public java.net.URL[] getDocs()

Description copied from interface: SolrInfoMBean

Documentation URL list.

Suggested documentation URLs: Homepage for sponsoring project, FAQ on class usage, Design doc for class, Wiki, bug reporting URL, etc...

Specified by:

getDocs in interface SolrInfoMBean

Overrides:

getDocs in class RequestHandlerBase