com.mapr.ojai.store.impl

Class MaterializedDocumentStream

java.lang.Object

com.mapr.ojai.store.impl.MaterializedDocumentStream

All Implemented Interfaces:

com.mapr.db.impl.OjaiQueryProperties, java.lang.AutoCloseable, java.lang.Iterable<org.ojai.Document>, org.ojai.DocumentStream

public class MaterializedDocumentStream
extends java.lang.Object
implements org.ojai.DocumentStream, com.mapr.db.impl.OjaiQueryProperties

Convenience for dealing with small result sets which must be presented as a DocumentStream. For example, a single document from an internal findById() can be returned using this.

Nested Class Summary

Nested classes/interfaces inherited from interface com.mapr.db.impl.OjaiQueryProperties

com.mapr.db.impl.OjaiQueryProperties.QueryPath

Constructor Summary

Constructors

Constructor and Description
MaterializedDocumentStream(org.ojai.Document document, com.mapr.db.impl.OjaiQueryProperties.QueryPath queryPath, java.lang.String indexUsed, org.ojai.FieldPath... fieldPath) Constructor for a single result.
MaterializedDocumentStream(com.mapr.db.impl.OjaiQueryProperties.QueryPath queryPath, java.lang.String indexUsed) Constructor for an empty result.

Method Summary

Modifier and Type	Method and Description
void	close()
java.lang.Iterable<org.ojai.DocumentReader>	documentReaders()
java.lang.String	getIndexUsed()
com.mapr.db.impl.OjaiQueryProperties.QueryPath	getQueryPath()
org.ojai.Document	getQueryPlan()
void	getQueryPlan(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> planList)
java.util.Iterator<org.ojai.Document>	iterator()
void	streamTo(org.ojai.DocumentListener documentListener)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MaterializedDocumentStream

public MaterializedDocumentStream(org.ojai.Document document,
                                  com.mapr.db.impl.OjaiQueryProperties.QueryPath queryPath,
                                  java.lang.String indexUsed,
                                  org.ojai.FieldPath... fieldPath)

Constructor for a single result.

Parameters:

document - single result

MaterializedDocumentStream

public MaterializedDocumentStream(com.mapr.db.impl.OjaiQueryProperties.QueryPath queryPath,
                                  java.lang.String indexUsed)

Constructor for an empty result.

Method Detail

close

public void close()
           throws org.ojai.exceptions.OjaiException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface org.ojai.DocumentStream

Throws:

org.ojai.exceptions.OjaiException

documentReaders

public java.lang.Iterable<org.ojai.DocumentReader> documentReaders()

Specified by:

documentReaders in interface org.ojai.DocumentStream

iterator

public java.util.Iterator<org.ojai.Document> iterator()

Specified by:

iterator in interface java.lang.Iterable<org.ojai.Document>

Specified by:

iterator in interface org.ojai.DocumentStream

streamTo

public void streamTo(org.ojai.DocumentListener documentListener)

Specified by:

streamTo in interface org.ojai.DocumentStream

getQueryPath

public com.mapr.db.impl.OjaiQueryProperties.QueryPath getQueryPath()

Specified by:

getQueryPath in interface com.mapr.db.impl.OjaiQueryProperties

getIndexUsed

public java.lang.String getIndexUsed()

Specified by:

getIndexUsed in interface com.mapr.db.impl.OjaiQueryProperties

getQueryPlan

public void getQueryPlan(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> planList)

Specified by:

getQueryPlan in interface com.mapr.db.impl.OjaiQueryProperties

getQueryPlan

public org.ojai.Document getQueryPlan()

Specified by:

getQueryPlan in interface org.ojai.DocumentStream