eu.ehri.project.models

Class DocumentaryUnit.Impl

java.lang.Object

eu.ehri.project.models.DocumentaryUnit.Impl

All Implemented Interfaces:

com.tinkerpop.frames.modules.javahandler.JavaHandlerContext<com.tinkerpop.blueprints.Vertex>, com.tinkerpop.frames.VertexFrame, AbstractUnit, Accessible, Annotatable, Described, Entity, Identifiable, ItemHolder, Linkable, PermissionGrantTarget, PermissionScope, Versioned, Watchable, DocumentaryUnit

Enclosing interface:

DocumentaryUnit

public abstract static class DocumentaryUnit.Impl
extends Object
implements com.tinkerpop.frames.modules.javahandler.JavaHandlerContext<com.tinkerpop.blueprints.Vertex>, DocumentaryUnit

Implementation of complex methods.

Nested Class Summary

Nested classes/interfaces inherited from interface eu.ehri.project.models.DocumentaryUnit

DocumentaryUnit.Impl

Field Summary

Fields inherited from interface eu.ehri.project.models.DocumentaryUnit

logger

Fields inherited from interface eu.ehri.project.models.base.ItemHolder

CHILD_COUNT

Fields inherited from interface eu.ehri.project.models.base.Watchable

WATCHED_COUNT

Constructor Summary

Constructors

Constructor and Description
Impl()

Method Summary

Modifier and Type	Method and Description
void	addChild(DocumentaryUnit child) Add a child document to this one.
Iterable<DocumentaryUnit>	getAllChildren() Fetch all ancestor items, including children of children to all depths.
Iterable<DocumentaryUnit>	getAncestors() Fetches a list of all ancestors (parent -> parent -> parent)
Iterable<DocumentaryUnit>	getAncestorsAndSelf() Get an iterable of ancestors, prefixed by this item.
int	getChildCount() Count the number of child units at the immediate lower level (not counting grand-children and lower ancestors.)
Iterable<DocumentaryUnit>	getChildren() Get child documentary units
Repository	getRepository() Get the repository that holds this documentary unit.
Iterable<VirtualUnit>	getVirtualCollections() Get virtual collections to which this documentary unit belongs.
void	setRepository(Repository repository) Set the repository that holds this documentary unit.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tinkerpop.frames.modules.javahandler.JavaHandlerContext

frame, frame, frame, frame, frame, frame, frameEdges, frameEdges, frameEdges, frameEdges, frameVertices, frameVertices, g, gremlin, gremlin, it

Methods inherited from interface eu.ehri.project.models.DocumentaryUnit

getDocumentDescriptions, getParent, getRepositoryIfTopLevel

Methods inherited from interface eu.ehri.project.models.base.Described

addDescription, getDescriptions, removeDescription

Methods inherited from interface eu.ehri.project.models.base.PermissionScope

getAllContainedItems, getContainedItems, getPermissionGrants, getPermissionScopes, idPath

Methods inherited from interface eu.ehri.project.models.base.Identifiable

getIdentifier

Methods inherited from interface eu.ehri.project.models.base.Linkable

addLink, getLinks

Methods inherited from interface eu.ehri.project.models.base.Accessible

addAccessor, getAccessors, getHistory, getLatestEvent, getPermissionScope, getPermissionScopes, hasAccessRestriction, removeAccessor, setPermissionScope

Methods inherited from interface eu.ehri.project.models.base.PermissionGrantTarget

getPermissionGrants

Methods inherited from interface eu.ehri.project.models.base.Entity

as, getId, getProperty, getProperty, getPropertyKeys, getType

Methods inherited from interface com.tinkerpop.frames.VertexFrame

asVertex

Methods inherited from interface eu.ehri.project.models.base.Watchable

getWatchedCount, getWatchers

Methods inherited from interface eu.ehri.project.models.base.Versioned

getAllPriorVersions, getPriorVersion

Methods inherited from interface eu.ehri.project.models.base.Annotatable

addAnnotation, addAnnotationPart, getAnnotations

Constructor Detail

Impl

public Impl()

Method Detail

getChildCount

public int getChildCount()

Description copied from interface: DocumentaryUnit

Count the number of child units at the immediate lower level (not counting grand-children and lower ancestors.)

Specified by:

getChildCount in interface ItemHolder

Specified by:

getChildCount in interface DocumentaryUnit

Returns:

the number of immediate child items

getChildren

public Iterable<DocumentaryUnit> getChildren()

Description copied from interface: DocumentaryUnit

Get child documentary units

Specified by:

getChildren in interface DocumentaryUnit

Returns:

an Iterable of DocumentaryUnits that are children

addChild

public void addChild(DocumentaryUnit child)

Description copied from interface: DocumentaryUnit

Add a child document to this one.

Specified by:

addChild in interface DocumentaryUnit

Parameters:

child - a documentary unit instance

getAllChildren

public Iterable<DocumentaryUnit> getAllChildren()

Description copied from interface: DocumentaryUnit

Fetch all ancestor items, including children of children to all depths.

Specified by:

getAllChildren in interface DocumentaryUnit

Returns:

child items at all lower levels

setRepository

public void setRepository(Repository repository)

Description copied from interface: DocumentaryUnit

Set the repository that holds this documentary unit.

Specified by:

setRepository in interface DocumentaryUnit

Parameters:

repository - a repository instance

getRepository

public Repository getRepository()

Description copied from interface: DocumentaryUnit

Get the repository that holds this documentary unit.

Specified by:

getRepository in interface DocumentaryUnit

Returns:

the repository that holds this DocumentaryUnit

getAncestors

public Iterable<DocumentaryUnit> getAncestors()

Description copied from interface: DocumentaryUnit

Fetches a list of all ancestors (parent -> parent -> parent)

Specified by:

getAncestors in interface DocumentaryUnit

Returns:

an Iterable of DocumentaryUnits that are ancestors

getAncestorsAndSelf

public Iterable<DocumentaryUnit> getAncestorsAndSelf()

Description copied from interface: DocumentaryUnit

Get an iterable of ancestors, prefixed by this item.

Specified by:

getAncestorsAndSelf in interface DocumentaryUnit

Returns:

an iterable of DocumentaryUnit items including the current item

getVirtualCollections

public Iterable<VirtualUnit> getVirtualCollections()

Description copied from interface: DocumentaryUnit

Get virtual collections to which this documentary unit belongs.

Specified by:

getVirtualCollections in interface DocumentaryUnit

Returns:

an iterable of virtual unit objects at the top level