com.redhat.lightblue.assoc

Class ChildDocReference

java.lang.Object

com.redhat.lightblue.assoc.ChildDocReference

All Implemented Interfaces:

Serializable

public class ChildDocReference
extends Object
implements Serializable

Represents a reference to another document for another entity. A reference is from a document:field pair to another document. There can be multiple references from a particular document to the documents of the same entity, for instance, if the reference is an array element.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChildDocReference(ResultDoc document, Path field) Constructs a reference for the given document and field

Method Summary

Methods

Modifier and Type	Method and Description
List<ResultDoc>	getChildren() Returns the child documents for this reference
ResultDoc	getDocument() Returns the source document
Path	getReferenceField() Returns the field in the source document that this reference represents
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChildDocReference

public ChildDocReference(ResultDoc document,
                 Path field)

Constructs a reference for the given document and field

Method Detail

getDocument

public ResultDoc getDocument()

Returns the source document

getReferenceField

public Path getReferenceField()

Returns the field in the source document that this reference represents

getChildren

public List<ResultDoc> getChildren()

Returns the child documents for this reference

toString

public String toString()

Overrides:

toString in class Object