com.yahoo.search.federation.vespa

Class ResultBuilder

java.lang.Object

org.xml.sax.helpers.DefaultHandler

com.yahoo.search.federation.vespa.ResultBuilder

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class ResultBuilder
extends DefaultHandler

Parse Vespa XML results and create Result instances.

Author:

Steinar Knutsen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ResultBuilder.ResultPart
private static class	ResultBuilder.Tag

Field Summary

Fields

Modifier and Type	Field and Description
private String	currentError
private String	currentErrorCode
protected static boolean	DEFAULT_DYNAMIC_VALIDATION Default dynamic validation support (false).
protected static boolean	DEFAULT_NAMESPACE_PREFIXES Default namespace prefixes (false).
protected static boolean	DEFAULT_NAMESPACES Default namespaces support (false).
protected static String	DEFAULT_PARSER_NAME Default parser name.
protected static boolean	DEFAULT_SCHEMA_VALIDATION Default Schema validation support (false).
protected static boolean	DEFAULT_VALIDATION Default validation support (false).
protected static String	DYNAMIC_VALIDATION_FEATURE_ID Dynamic validation feature id (http://apache.org/xml/features/validation/dynamic).
private static String	ERROR
private static String	FIELD
private StringBuilder	fieldContent
private int	fieldLevel
private String	fieldName
private boolean	hasLiteralTags
private Map<String,Object>	hitFields
private Deque<HitGroup>	hitGroups
private String	hitRelevance
private String	hitSource
private String	hitType
(package private) Deque<ResultBuilder.ResultPart>	location
private static Logger	log
protected static String	NAMESPACE_PREFIXES_FEATURE_ID Namespace prefixes feature id (http://xml.org/sax/features/namespace-prefixes).
protected static String	NAMESPACES_FEATURE_ID Namespaces feature id (http://xml.org/sax/features/namespaces).
private int	offset
private XMLReader	parser
private Query	query
private Result	result
protected static String	SCHEMA_VALIDATION_FEATURE_ID Schema validation feature id (http://apache.org/xml/features/validation/schema).
private List<ResultBuilder.Tag>	tagStack
protected static String	VALIDATION_FEATURE_ID Validation feature id (http://xml.org/sax/features/validation).

Constructor Summary

Constructors

Constructor and Description
ResultBuilder() Default constructor.
ResultBuilder(XMLReader parser)

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
static XMLReader	createParser()
void	endElement(String namespaceURI, String localName, String qName)
private void	endElementInField(String qName, String enclosingTag)
private void	endElementInHitField(String qName)
void	error(SAXParseException ex)
private Object	extractDocumentID()
void	fatalError(SAXParseException ex)
void	ignorableWhitespace(char[] ch, int start, int length)
Result	parse(InputSource input, Query query)
Result	parse(String identifier, Query query)
protected void	printError(String type, SAXParseException ex) Prints the error message.
void	processingInstruction(String target, String data)
private void	reset()
private static void	setParserFeatures(XMLReader reader)
private void	setQuery(Query query)
void	startDocument()
void	startElement(String uri, String local, String raw, Attributes attrs)
private void	startHit(Attributes attrs)
private void	startHitGroup(Attributes attrs)
private void	tagInField(String tag, Attributes attrs, String enclosingTag)
void	warning(SAXParseException ex)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, notationDecl, resolveEntity, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Field Detail

ERROR

private static final String ERROR

See Also:

Constant Field Values

FIELD

private static final String FIELD

See Also:

Constant Field Values

log

private static Logger log

NAMESPACES_FEATURE_ID

protected static final String NAMESPACES_FEATURE_ID

Namespaces feature id (http://xml.org/sax/features/namespaces).

See Also:

Constant Field Values

NAMESPACE_PREFIXES_FEATURE_ID

protected static final String NAMESPACE_PREFIXES_FEATURE_ID

Namespace prefixes feature id (http://xml.org/sax/features/namespace-prefixes).

See Also:

Constant Field Values

VALIDATION_FEATURE_ID

protected static final String VALIDATION_FEATURE_ID

Validation feature id (http://xml.org/sax/features/validation).

See Also:

Constant Field Values

SCHEMA_VALIDATION_FEATURE_ID

protected static final String SCHEMA_VALIDATION_FEATURE_ID

Schema validation feature id (http://apache.org/xml/features/validation/schema).

See Also:

Constant Field Values

DYNAMIC_VALIDATION_FEATURE_ID

protected static final String DYNAMIC_VALIDATION_FEATURE_ID

Dynamic validation feature id (http://apache.org/xml/features/validation/dynamic).

See Also:

Constant Field Values

DEFAULT_PARSER_NAME

protected static final String DEFAULT_PARSER_NAME

Default parser name.

See Also:

Constant Field Values

DEFAULT_NAMESPACES

protected static final boolean DEFAULT_NAMESPACES

Default namespaces support (false).

See Also:

Constant Field Values

DEFAULT_NAMESPACE_PREFIXES

protected static final boolean DEFAULT_NAMESPACE_PREFIXES

Default namespace prefixes (false).

See Also:

Constant Field Values

DEFAULT_VALIDATION

protected static final boolean DEFAULT_VALIDATION

Default validation support (false).

See Also:

Constant Field Values

DEFAULT_SCHEMA_VALIDATION

protected static final boolean DEFAULT_SCHEMA_VALIDATION

Default Schema validation support (false).

See Also:

Constant Field Values

DEFAULT_DYNAMIC_VALIDATION

protected static final boolean DEFAULT_DYNAMIC_VALIDATION

Default dynamic validation support (false).

See Also:

Constant Field Values

fieldContent

private StringBuilder fieldContent

fieldName

private String fieldName

fieldLevel

private int fieldLevel

hasLiteralTags

private boolean hasLiteralTags

hitFields

private Map<String,Object> hitFields

hitType

private String hitType

hitRelevance

private String hitRelevance

hitSource

private String hitSource

offset

private int offset

tagStack

private List<ResultBuilder.Tag> tagStack

parser

private final XMLReader parser

query

private Query query

result

private Result result

location

Deque<ResultBuilder.ResultPart> location

currentErrorCode

private String currentErrorCode

currentError

private String currentError

hitGroups

private Deque<HitGroup> hitGroups

Constructor Detail

ResultBuilder

public ResultBuilder()
              throws RuntimeException

Default constructor.

Throws:

RuntimeException

ResultBuilder

public ResultBuilder(XMLReader parser)

Method Detail

createParser

public static XMLReader createParser()

setParserFeatures

private static void setParserFeatures(XMLReader reader)

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException

reset

private void reset()

startElement

public void startElement(String uri,
                         String local,
                         String raw,
                         Attributes attrs)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

startHitGroup

private void startHitGroup(Attributes attrs)

startHit

private void startHit(Attributes attrs)

tagInField

private void tagInField(String tag,
                        Attributes attrs,
                        String enclosingTag)

endElementInField

private void endElementInField(String qName,
                               String enclosingTag)

endElementInHitField

private void endElementInHitField(String qName)

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws SAXException

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class DefaultHandler

Throws:

SAXException

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException

Specified by:

processingInstruction in interface ContentHandler

Overrides:

processingInstruction in class DefaultHandler

Throws:

SAXException

endElement

public void endElement(String namespaceURI,
                       String localName,
                       String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

extractDocumentID

private Object extractDocumentID()

warning

public void warning(SAXParseException ex)
             throws SAXException

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class DefaultHandler

Throws:

SAXException

error

public void error(SAXParseException ex)
           throws SAXException

Specified by:

error in interface ErrorHandler

Overrides:

error in class DefaultHandler

Throws:

SAXException

fatalError

public void fatalError(SAXParseException ex)
                throws SAXException

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class DefaultHandler

Throws:

SAXException

printError

protected void printError(String type,
                          SAXParseException ex)

Prints the error message.

parse

public Result parse(String identifier,
                    Query query)

parse

public Result parse(InputSource input,
                    Query query)

setQuery

private void setQuery(Query query)