org.apache.solr.response

Class XMLWriter

java.lang.Object

org.apache.solr.response.XMLWriter

public final class XMLWriter
extends java.lang.Object

Version:

$Id: XMLWriter.java 1171741 2011-09-16 19:29:23Z hossman $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static interface	XMLWriter.DocumentListInfo

Field Summary

Fields

Modifier and Type	Field and Description
static float	CURRENT_VERSION
private java.util.Set<java.lang.String>	defaultFieldList
private boolean	defaultIndent
private boolean	doIndent
private static java.util.Comparator	fieldnameComparator
(package private) static char[]	indentChars
private int	indentThreshold
private int	level
private SolrQueryRequest	request
private java.lang.StringBuilder	sb
private IndexSchema	schema
private java.util.ArrayList	tlst
(package private) int	version
private java.io.Writer	writer
private static char[]	XML_START1
private static char[]	XML_START2_NOSCHEMA
private static char[]	XML_START2_SCHEMA
private static char[]	XML_STYLESHEET
private static char[]	XML_STYLESHEET_END

Constructor Summary

Constructors

Constructor and Description
XMLWriter(java.io.Writer writer, IndexSchema schema, SolrQueryRequest req, java.lang.String version)

Method Summary

Modifier and Type	Method and Description
int	decLevel()
int	incLevel()
void	indent()
void	indent(int lev)
int	level()
void	setIndent(boolean doIndent)
void	setLevel(int level)
void	startTag(java.lang.String tag, java.util.Map<java.lang.String,java.lang.String> attributes, boolean closeTag, boolean escape) Writes a tag with attributes
void	startTag(java.lang.String tag, java.lang.String name, boolean closeTag)
void	writeArray(java.lang.String name, java.util.Iterator iter)
void	writeArray(java.lang.String name, java.lang.Object[] val)
void	writeAttr(java.lang.String name, java.lang.String val) Writes the XML attribute name/val.
void	writeAttr(java.lang.String name, java.lang.String val, boolean escape)
void	writeBool(java.lang.String name, boolean val)
void	writeBool(java.lang.String name, java.lang.String val)
void	writeByte(java.lang.String name, byte val)
void	writeByte(java.lang.String name, java.lang.String val)
void	writeCdataTag(java.lang.String tag, java.util.Map<java.lang.String,java.lang.String> attributes, java.lang.String cdata, boolean escapeCdata, boolean escapeAttr) Write a complete tag w/ attributes and cdata (the cdata is not enclosed in $lt;!CDATA[]!>
void	writeDate(java.lang.String name, java.util.Date val)
void	writeDate(java.lang.String name, java.lang.String val)
void	writeDoc(java.lang.String name, org.apache.lucene.document.Document doc, java.util.Set<java.lang.String> returnFields, float score, boolean includeScore)
(package private) void	writeDoc(java.lang.String name, SolrDocument doc, java.util.Set<java.lang.String> returnFields, boolean includeScore)
void	writeDocList(java.lang.String name, DocList ids, java.util.Set<java.lang.String> fields)
private void	writeDocuments(java.lang.String name, XMLWriter.DocumentListInfo docs, java.util.Set<java.lang.String> fields)
void	writeDouble(java.lang.String name, double val)
void	writeDouble(java.lang.String name, java.lang.String val)
void	writeFloat(java.lang.String name, float val)
void	writeFloat(java.lang.String name, java.lang.String val)
void	writeInt(java.lang.String name, int val)
void	writeInt(java.lang.String name, java.lang.String val)
void	writeLong(java.lang.String name, long val)
void	writeLong(java.lang.String name, java.lang.String val)
void	writeMap(java.lang.String name, java.util.Map<java.lang.Object,java.lang.Object> map) writes a Map in the same format as a NamedList, using the stringification of the key Object when it's non-null.
void	writeNamedList(java.lang.String name, NamedList val)
void	writeNull(java.lang.String name)
void	writePrim(java.lang.String tag, java.lang.String name, java.lang.String val, boolean escape)
static void	writeResponse(java.io.Writer writer, SolrQueryRequest req, SolrQueryResponse rsp)
void	writeShort(java.lang.String name, short val)
void	writeShort(java.lang.String name, java.lang.String val)
void	writeSolrDocumentList(java.lang.String name, SolrDocumentList docs, java.util.Set<java.lang.String> fields)
void	writeStr(java.lang.String name, java.lang.String val)
void	writeVal(java.lang.String name, java.lang.Object val)

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_VERSION

public static float CURRENT_VERSION

XML_START1

private static final char[] XML_START1

XML_STYLESHEET

private static final char[] XML_STYLESHEET

XML_STYLESHEET_END

private static final char[] XML_STYLESHEET_END

XML_START2_SCHEMA

private static final char[] XML_START2_SCHEMA

XML_START2_NOSCHEMA

private static final char[] XML_START2_NOSCHEMA

writer

private final java.io.Writer writer

schema

private final IndexSchema schema

request

private final SolrQueryRequest request

level

private int level

defaultIndent

private boolean defaultIndent

doIndent

private boolean doIndent

defaultFieldList

private java.util.Set<java.lang.String> defaultFieldList

indentThreshold

private final int indentThreshold

See Also:

Constant Field Values

version

final int version

tlst

private final java.util.ArrayList tlst

sb

private final java.lang.StringBuilder sb

indentChars

static final char[] indentChars

fieldnameComparator

private static final java.util.Comparator fieldnameComparator

Constructor Detail

XMLWriter

public XMLWriter(java.io.Writer writer,
                 IndexSchema schema,
                 SolrQueryRequest req,
                 java.lang.String version)

Method Detail

writeResponse

public static void writeResponse(java.io.Writer writer,
                                 SolrQueryRequest req,
                                 SolrQueryResponse rsp)
                          throws java.io.IOException

Throws:

java.io.IOException

setLevel

public void setLevel(int level)

level

public int level()

incLevel

public int incLevel()

decLevel

public int decLevel()

setIndent

public void setIndent(boolean doIndent)

writeAttr

public void writeAttr(java.lang.String name,
                      java.lang.String val)
               throws java.io.IOException

Writes the XML attribute name/val. A null val means that the attribute is missing.

Throws:

java.io.IOException

writeAttr

public void writeAttr(java.lang.String name,
                      java.lang.String val,
                      boolean escape)
               throws java.io.IOException

Throws:

java.io.IOException

startTag

public void startTag(java.lang.String tag,
                     java.util.Map<java.lang.String,java.lang.String> attributes,
                     boolean closeTag,
                     boolean escape)
              throws java.io.IOException

Writes a tag with attributes

Parameters:

tag -

attributes -

closeTag -

escape -

Throws:

java.io.IOException

writeCdataTag

public void writeCdataTag(java.lang.String tag,
                          java.util.Map<java.lang.String,java.lang.String> attributes,
                          java.lang.String cdata,
                          boolean escapeCdata,
                          boolean escapeAttr)
                   throws java.io.IOException

Write a complete tag w/ attributes and cdata (the cdata is not enclosed in $lt;!CDATA[]!>

Parameters:

tag -

attributes -

cdata -

escapeCdata -

escapeAttr -

Throws:

java.io.IOException

startTag

public void startTag(java.lang.String tag,
                     java.lang.String name,
                     boolean closeTag)
              throws java.io.IOException

Throws:

java.io.IOException

indent

public void indent()
            throws java.io.IOException

Throws:

java.io.IOException

indent

public void indent(int lev)
            throws java.io.IOException

Throws:

java.io.IOException

writeDoc

public final void writeDoc(java.lang.String name,
                           org.apache.lucene.document.Document doc,
                           java.util.Set<java.lang.String> returnFields,
                           float score,
                           boolean includeScore)
                    throws java.io.IOException

Throws:

java.io.IOException

writeDoc

final void writeDoc(java.lang.String name,
                    SolrDocument doc,
                    java.util.Set<java.lang.String> returnFields,
                    boolean includeScore)
             throws java.io.IOException

Throws:

java.io.IOException

Since:

solr 1.3

writeDocuments

private final void writeDocuments(java.lang.String name,
                                  XMLWriter.DocumentListInfo docs,
                                  java.util.Set<java.lang.String> fields)
                           throws java.io.IOException

Throws:

java.io.IOException

writeSolrDocumentList

public final void writeSolrDocumentList(java.lang.String name,
                                        SolrDocumentList docs,
                                        java.util.Set<java.lang.String> fields)
                                 throws java.io.IOException

Throws:

java.io.IOException

writeDocList

public final void writeDocList(java.lang.String name,
                               DocList ids,
                               java.util.Set<java.lang.String> fields)
                        throws java.io.IOException

Throws:

java.io.IOException

writeVal

public void writeVal(java.lang.String name,
                     java.lang.Object val)
              throws java.io.IOException

Throws:

java.io.IOException

writeNamedList

public void writeNamedList(java.lang.String name,
                           NamedList val)
                    throws java.io.IOException

Throws:

java.io.IOException

writeMap

public void writeMap(java.lang.String name,
                     java.util.Map<java.lang.Object,java.lang.Object> map)
              throws java.io.IOException

writes a Map in the same format as a NamedList, using the stringification of the key Object when it's non-null.

Parameters:

name -

map -

Throws:

java.io.IOException

See Also:

Note on Returnable Data

writeArray

public void writeArray(java.lang.String name,
                       java.lang.Object[] val)
                throws java.io.IOException

Throws:

java.io.IOException

writeArray

public void writeArray(java.lang.String name,
                       java.util.Iterator iter)
                throws java.io.IOException

Throws:

java.io.IOException

writeNull

public void writeNull(java.lang.String name)
               throws java.io.IOException

Throws:

java.io.IOException

writeStr

public void writeStr(java.lang.String name,
                     java.lang.String val)
              throws java.io.IOException

Throws:

java.io.IOException

writeInt

public void writeInt(java.lang.String name,
                     java.lang.String val)
              throws java.io.IOException

Throws:

java.io.IOException

writeInt

public void writeInt(java.lang.String name,
                     int val)
              throws java.io.IOException

Throws:

java.io.IOException

writeLong

public void writeLong(java.lang.String name,
                      java.lang.String val)
               throws java.io.IOException

Throws:

java.io.IOException

writeLong

public void writeLong(java.lang.String name,
                      long val)
               throws java.io.IOException

Throws:

java.io.IOException

writeBool

public void writeBool(java.lang.String name,
                      java.lang.String val)
               throws java.io.IOException

Throws:

java.io.IOException

writeBool

public void writeBool(java.lang.String name,
                      boolean val)
               throws java.io.IOException

Throws:

java.io.IOException

writeShort

public void writeShort(java.lang.String name,
                       java.lang.String val)
                throws java.io.IOException

Throws:

java.io.IOException

writeShort

public void writeShort(java.lang.String name,
                       short val)
                throws java.io.IOException

Throws:

java.io.IOException

writeByte

public void writeByte(java.lang.String name,
                      java.lang.String val)
               throws java.io.IOException

Throws:

java.io.IOException

writeByte

public void writeByte(java.lang.String name,
                      byte val)
               throws java.io.IOException

Throws:

java.io.IOException

writeFloat

public void writeFloat(java.lang.String name,
                       java.lang.String val)
                throws java.io.IOException

Throws:

java.io.IOException

writeFloat

public void writeFloat(java.lang.String name,
                       float val)
                throws java.io.IOException

Throws:

java.io.IOException

writeDouble

public void writeDouble(java.lang.String name,
                        java.lang.String val)
                 throws java.io.IOException

Throws:

java.io.IOException

writeDouble

public void writeDouble(java.lang.String name,
                        double val)
                 throws java.io.IOException

Throws:

java.io.IOException

writeDate

public void writeDate(java.lang.String name,
                      java.util.Date val)
               throws java.io.IOException

Throws:

java.io.IOException

writeDate

public void writeDate(java.lang.String name,
                      java.lang.String val)
               throws java.io.IOException

Throws:

java.io.IOException

writePrim

public void writePrim(java.lang.String tag,
                      java.lang.String name,
                      java.lang.String val,
                      boolean escape)
               throws java.io.IOException

Throws:

java.io.IOException