com.redhat.lightblue.assoc.ep

Class ResultDocument

java.lang.Object

com.redhat.lightblue.assoc.ep.ResultDocument

public class ResultDocument
extends Object

A document, and its slots. Slots are organized by their reference fields. If a slot is in an array element, the constructor creates slots for every element in that array. Thus, every slot is connected to a path containing no '*'s

Constructor Summary

Constructors

Constructor and Description
ResultDocument(ExecutionBlock block, JsonDoc doc)
ResultDocument(JsonDoc newDoc, ResultDocument copy) Copy constructor, copies everything from 'copy', but replaces the document with 'newDoc'

Method Summary

Modifier and Type	Method and Description
Map<ChildSlot,BindQuery>	getBindersForChild(AssociationQuery childAq) If this document is the parent document of a destination block documents, then the child documents will be inserted into the slots of this document.
List<BindQuery>	getBindersForParent(AssociationQuery parentAq) This document is a child document, and it will be used to locate the parent.
BindQuery	getBindersForSlot(ChildSlot slot, AssociationQuery childAq) Returns a query binder for a slot.
ExecutionBlock	getBlock() Returns the execution block produced this document
JsonDoc	getDoc()
DocId	getDocId() Returns the document identifier.
Map<ResolvedReferenceField,List<ChildSlot>>	getSlots() Returns the slots for this document
void	insertChildDocs(ChildSlot slot, java.util.stream.Stream<ResultDocument> childDocs) Insert the child documents into a slot of this document
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultDocument

public ResultDocument(ExecutionBlock block,
                      JsonDoc doc)

ResultDocument

public ResultDocument(JsonDoc newDoc,
                      ResultDocument copy)

Copy constructor, copies everything from 'copy', but replaces the document with 'newDoc'

Method Detail

getDoc

public JsonDoc getDoc()

getBlock

public ExecutionBlock getBlock()

Returns the execution block produced this document

getDocId

public DocId getDocId()

Returns the document identifier.

getSlots

public Map<ResolvedReferenceField,List<ChildSlot>> getSlots()

Returns the slots for this document

getBindersForChild

public Map<ChildSlot,BindQuery> getBindersForChild(AssociationQuery childAq)

If this document is the parent document of a destination block documents, then the child documents will be inserted into the slots of this document. This function builds a BindQuery object for each slot. If the child document attaches to an array element, then there will be multiple slots in the returned map, one for each array element. If not, there will be only one slot for each field. The child block will retrieve documents based on queries written using the binder, and attach the child documents to the corresponding slot

getBindersForSlot

public BindQuery getBindersForSlot(ChildSlot slot,
                                   AssociationQuery childAq)

Returns a query binder for a slot. The slot cannot have '*' in it (i.e. there must be only one location for the slot in the document).

getBindersForParent

public List<BindQuery> getBindersForParent(AssociationQuery parentAq)

This document is a child document, and it will be used to locate the parent. The destination block needs queries based on the values in this document to retrieve those documents. The return value is a list of BindQuery objects, each should be used to write queries to search for parent documents.

insertChildDocs

public void insertChildDocs(ChildSlot slot,
                            java.util.stream.Stream<ResultDocument> childDocs)

Insert the child documents into a slot of this document

Parameters:

parentDoc - The parent document

childDocs - A list of child docs

dest - The destination field name to insert the result set

toString

public String toString()

Overrides:

toString in class Object