eu.ehri.project.models

Interface DocumentaryUnit

All Superinterfaces:

AbstractUnit, Accessible, Annotatable, Described, Entity, Identifiable, ItemHolder, Linkable, PermissionGrantTarget, PermissionScope, Versioned, com.tinkerpop.frames.VertexFrame, Watchable

All Known Implementing Classes:

DocumentaryUnit.Impl

public interface DocumentaryUnit
extends AbstractUnit

A frame class for graph nodes representing documentary unit items.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DocumentaryUnit.Impl Implementation of complex methods.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	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

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
Iterable<DocumentaryUnitDescription>	getDocumentDescriptions() Get the description items for this documentary unit.
DocumentaryUnit	getParent() Get parent documentary unit, if any
Repository	getRepository() Get the repository that holds this documentary unit.
Repository	getRepositoryIfTopLevel() Get the repository if this item is at the top of its hierarchy.
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 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

Field Detail

logger

static final org.slf4j.Logger logger

Method Detail

getRepository

Repository getRepository()

Get the repository that holds this documentary unit.

Returns:

the repository that holds this DocumentaryUnit

getRepositoryIfTopLevel

Repository getRepositoryIfTopLevel()

Get the repository if this item is at the top of its hierarchy. Otherwise, return null.

Returns:

the repository, or null.

setRepository

void setRepository(Repository repository)

Set the repository that holds this documentary unit.

Parameters:

repository - a repository instance

getParent

DocumentaryUnit getParent()

Get parent documentary unit, if any

Returns:

a DocumentaryUnit that is this DocumentaryUnit's parent or null

addChild

void addChild(DocumentaryUnit child)

Add a child document to this one.

Parameters:

child - a documentary unit instance

getAncestors

Iterable<DocumentaryUnit> getAncestors()

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

Returns:

an Iterable of DocumentaryUnits that are ancestors

getAncestorsAndSelf

Iterable<DocumentaryUnit> getAncestorsAndSelf()

Get an iterable of ancestors, prefixed by this item.

Returns:

an iterable of DocumentaryUnit items including the current item

getVirtualCollections

Iterable<VirtualUnit> getVirtualCollections()

Get virtual collections to which this documentary unit belongs.

Returns:

an iterable of virtual unit objects at the top level

getChildCount

int getChildCount()

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

Specified by:

getChildCount in interface ItemHolder

Returns:

the number of immediate child items

getChildren

Iterable<DocumentaryUnit> getChildren()

Get child documentary units

Returns:

an Iterable of DocumentaryUnits that are children

getAllChildren

Iterable<DocumentaryUnit> getAllChildren()

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

Returns:

child items at all lower levels

getDocumentDescriptions

Iterable<DocumentaryUnitDescription> getDocumentDescriptions()

Get the description items for this documentary unit.

Returns:

a iterable of document descriptions