Uses of Interface
org.ojai.DocumentReader

Packages that use DocumentReader

Package	Description
org.ojai
org.ojai.base
org.ojai.beans
org.ojai.json
org.ojai.util

Uses of DocumentReader in org.ojai

Methods in org.ojai that return DocumentReader

Modifier and Type	Method and Description
DocumentReader	Value.asReader() Returns a DocumentReader over the current document.
DocumentReader	Document.asReader()
DocumentReader	Document.asReader(FieldPath fieldPath)
DocumentReader	Document.asReader(String fieldPath)
DocumentReader	DocumentReader.skipChildren() When called after DocumentReader.EventType.START_MAP or DocumentReader.EventType.START_ARRAY event, moves this DocumentReader to the corresponding DocumentReader.EventType.END_MAP or DocumentReader.EventType.END_ARRAY, skipping the entire sub-tree.

Methods in org.ojai that return types with arguments of type DocumentReader

Modifier and Type	Method and Description
Iterable<DocumentReader>	DocumentStream.documentReaders() Returns an Iterable over a set of DocumentReader.

Uses of DocumentReader in org.ojai.base

Classes in org.ojai.base that implement DocumentReader

Modifier and Type	Class and Description
class	DocumentReaderBase A template abstract class that implements the DocumentReader interface.

Methods in org.ojai.base that return DocumentReader

Modifier and Type	Method and Description
DocumentReader	DocumentBase.asReader(String fieldPath)
DocumentReader	DocumentReaderBase.skipChildren() This is a trivial implementation of DocumentReaderBase.skipChildren() API.

Methods in org.ojai.base that return types with arguments of type DocumentReader

Modifier and Type	Method and Description
Iterable<DocumentReader>	DocumentStreamBase.documentReaders()
protected Iterable<DocumentReader>	DocumentStreamBase.documentReadersDerived()

Uses of DocumentReader in org.ojai.beans

Methods in org.ojai.beans with parameters of type DocumentReader

Modifier and Type	Method and Description
static <T> T	BeanCodec.encode(DocumentReader dr, Class<T> beanClass)

Uses of DocumentReader in org.ojai.json

Methods in org.ojai.json that return DocumentReader

Modifier and Type	Method and Description
static DocumentReader	Json.newDocumentReader(String jsonString) Returns a new instance of the JSON DocumentReader.

Methods in org.ojai.json with parameters of type DocumentReader

Modifier and Type	Method and Description
boolean	Events.Delegate.bor(DocumentReader reader, Queue<Events.EventDescriptor> eventQueue)
boolean	Events.BaseDelegate.bor(DocumentReader reader, Queue<Events.EventDescriptor> eventQueue)
boolean	Events.Delegate.eor(DocumentReader reader, Queue<Events.EventDescriptor> eventQueue)
boolean	Events.BaseDelegate.eor(DocumentReader reader, Queue<Events.EventDescriptor> eventQueue)
boolean	Events.Delegate.process(DocumentReader reader, DocumentReader.EventType event, Queue<Events.EventDescriptor> eventQueue)
boolean	Events.BaseDelegate.process(DocumentReader reader, DocumentReader.EventType event, Queue<Events.EventDescriptor> eventQueue)
static String	Json.toJsonString(DocumentReader r)
static String	Json.toJsonString(DocumentReader r, JsonOptions options)
static void	Json.writeReaderToBuilder(DocumentReader r, DocumentBuilder w) Deprecated. Use Documents.writeReaderToBuilder(DocumentReader, DocumentBuilder)

Uses of DocumentReader in org.ojai.util

Classes in org.ojai.util that implement DocumentReader

Modifier and Type	Class and Description
class	DocumentReaderWithProjection An implementation of DocumentReader interface which can be used to project a sub-set of fields

Methods in org.ojai.util that return DocumentReader

Modifier and Type	Method and Description
DocumentReader	DocumentReaderWithProjection.skipChildren()

Methods in org.ojai.util with parameters of type DocumentReader

Modifier and Type	Method and Description
static Map<String,Object>	MapEncoder.encode(DocumentReader reader) Deprecated. Encodes values from the specified DocumentReader into a Java Map.
static Map<String,Object>	DocumentReaders.encode(DocumentReader reader) Encodes values from the specified DocumentReader into a Java Map.
static List<Object>	DocumentReaders.encodeArray(DocumentReader dr) Encodes values from the specified DocumentReader into a Java Map. This method should be called after consuming DocumentReader.EventType.START_ARRAY.
static Map<String,Object>	DocumentReaders.encodeMap(DocumentReader dr) Encodes values from the specified DocumentReader into a Java List. The difference between this method and DocumentReaders.encode(DocumentReader) is that this should be called after consuming DocumentReader.EventType.START_MAP.
static Object	DocumentReaders.encodeValue(DocumentReader dr) Returns the corresponding Java Object for the current node in DocumentReader.
FieldProjector	FieldProjector.reset(DocumentReader reader) Resets the state of this projection tree to the root of the Document.
protected BaseFieldProjector	BaseFieldProjector.reset(DocumentReader reader) Resets the state of this projection tree to the root of the Document.
static void	Documents.writeReaderToBuilder(DocumentReader reader, DocumentBuilder builder) This method can be used to build a Document (via DocumentBuilder) from a DocumentReader instance.

Constructors in org.ojai.util with parameters of type DocumentReader

Constructor and Description
DocumentReaderWithProjection(DocumentReader reader, FieldProjector projection)