Uses of Interface
eu.ehri.project.models.base.Entity

Packages that use Entity

Package	Description
eu.ehri.extension.base
eu.ehri.project.acl	Classes pertaining directly to the access-control and permission system.
eu.ehri.project.api	Classes that provide data access data on the graph in a manner that incorporate the permission and access-control systems.
eu.ehri.project.api.impl
eu.ehri.project.core	Classes pertaining to the low-level management of vertices and edges.
eu.ehri.project.core.impl
eu.ehri.project.exporters.xml
eu.ehri.project.models	The interfaces in this package specify the classes of entities that map to graph frame classes.
eu.ehri.project.models.base	The interfaces in this package specify the required and allowable properties of classes of entities, so that entities can be validated.
eu.ehri.project.models.cvoc
eu.ehri.project.models.events
eu.ehri.project.persistence	Classes dealing with persistence of relational item data in sub-tree format.
eu.ehri.project.tools

Uses of Entity in eu.ehri.extension.base

Methods in eu.ehri.extension.base with type parameters of type Entity

Modifier and Type	Method and Description
protected <T extends Entity> javax.ws.rs.core.Response	AbstractAccessibleResource.exportItemsAsZip(XmlExporter<T> exporter, Iterable<T> items, String lang)
protected <T extends Entity> javax.ws.rs.core.CacheControl	AbstractResource.getCacheControl(T item) Get a cache control header based on the access restrictions set on the item.
protected <T extends Entity> javax.ws.rs.core.Response	AbstractResource.single(T item) Return a default response from a single frame item.
protected <T extends Entity> javax.ws.rs.core.Response	AbstractResource.streamingList(Supplier<Iterable<T>> list) Return a streaming response from an iterable.
protected <T extends Entity> javax.ws.rs.core.Response	AbstractResource.streamingList(Supplier<Iterable<T>> list, Serializer serializer) Return a streaming response from an iterable, using the given entity converter.
protected <T extends Entity> javax.ws.rs.core.Response	AbstractResource.streamingListOfLists(Supplier<Iterable<? extends Collection<T>>> lists) Return a streaming response from an iterable of item lists.
protected <T extends Entity> javax.ws.rs.core.Response	AbstractResource.streamingPage(Supplier<QueryApi.Page<T>> page) Stream a single page with total, limit, and offset info.
protected <T extends Entity> javax.ws.rs.core.Response	AbstractResource.streamingPage(Supplier<QueryApi.Page<T>> page, Serializer serializer) Stream a single page with total, limit, and offset info, using the given entity converter.

Methods in eu.ehri.extension.base with parameters of type Entity

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response	AbstractResource.creationResponse(Entity frame) Return a response from a new item with a 201 CREATED status.
protected URI	AbstractResource.getItemUri(Entity item) Get the URI for a given item.

Uses of Entity in eu.ehri.project.acl

Classes in eu.ehri.project.acl that implement Entity

Modifier and Type	Class and Description
class	AnonymousAccessor Implementation of an anonymous user singleton.
class	SystemScope Singleton class representing the system scope for permissions and ID namespaces.

Methods in eu.ehri.project.acl with type parameters of type Entity

Modifier and Type	Method and Description
<T extends Entity> T	AnonymousAccessor.as(Class<T> cls)
<T extends Entity> T	SystemScope.as(Class<T> cls)

Uses of Entity in eu.ehri.project.api

Methods in eu.ehri.project.api with type parameters of type Entity

Modifier and Type	Method and Description
<E extends Entity> QueryApi.Page<E>	QueryApi.page(Class<E> cls) Return a Page instance containing a total of total items, and an iterable for the given page/count.
<E extends Entity> QueryApi.Page<E>	QueryApi.page(EntityClass type, Class<E> cls) Return a Page instance containing a total of total items, and an iterable for the given page/count.
<E extends Entity> QueryApi.Page<E>	QueryApi.page(Iterable<? extends E> entities, Class<E> cls) Return a Page instance containing a total of total items, and an iterable for the given page/count.
<E extends Entity> QueryApi.Page<E>	QueryApi.page(String key, String query, Class<E> cls) Return a Page instance containing a total of total items, and an iterable for the given page/count.

Uses of Entity in eu.ehri.project.api.impl

Methods in eu.ehri.project.api.impl with type parameters of type Entity

Modifier and Type	Method and Description
<E extends Entity> QueryApi.Page<E>	QueryApiImpl.page(Class<E> cls) Return a Page instance containing a total of total items, and an iterable for the given page/count.
<E extends Entity> QueryApi.Page<E>	QueryApiImpl.page(EntityClass type, Class<E> cls) Return a Page instance containing a total of total items, and an iterable for the given page/count.
<E extends Entity> QueryApi.Page<E>	QueryApiImpl.page(Iterable<? extends E> entities, Class<E> cls) Return a Page instance containing a total of total items, and an iterable for the given page/count.
<E extends Entity> QueryApi.Page<E>	QueryApiImpl.page(String key, String query, Class<E> cls) Return a Page instance containing a total of total items, and an iterable for the given page/count.

Uses of Entity in eu.ehri.project.core

Methods in eu.ehri.project.core with parameters of type Entity

Modifier and Type	Method and Description
EntityClass	GraphManager.getEntityClass(Entity entity) Get the type of an arbitrary framed vertex.

Uses of Entity in eu.ehri.project.core.impl

Methods in eu.ehri.project.core.impl with parameters of type Entity

Modifier and Type	Method and Description
EntityClass	BlueprintsGraphManager.getEntityClass(Entity entity)

Uses of Entity in eu.ehri.project.exporters.xml

Classes in eu.ehri.project.exporters.xml with type parameters of type Entity

Modifier and Type	Class and Description
class	AbstractStreamingXmlExporter<E extends Entity>
interface	XmlExporter<T extends Entity>

Uses of Entity in eu.ehri.project.models

Subinterfaces of Entity in eu.ehri.project.models

Modifier and Type	Interface and Description
interface	AccessPoint Holds the information on a relationship specified in some Description, but without the target-end of the relationship being determined.
interface	Address A frame class representing an address.
interface	Annotation A frame class representing an annotation.
interface	ContentType Frame class representing a type of content in the graph.
interface	Country Frame class representing a country.
interface	DatePeriod Frame class representing a date period.
interface	DocumentaryUnit A frame class for graph nodes representing documentary unit items.
interface	DocumentaryUnitDescription Frame class representing the description of a document.
interface	Group Frame class representing a group of users or other groups that can be assigned permissions.
interface	HistoricalAgent A frame class representing a historical agent item.
interface	HistoricalAgentDescription Frame class representing the description of a historical agent.
interface	Link Links two items together with a given body, with may either be a text property or some other entity.
interface	MaintenanceEvent Frame class representing a pre-ingest event that took place upon some documentary unit item.
interface	Permission Frame class representing a type of permission.
interface	PermissionGrant Frame class representing a grant of a permission to a user.
interface	Repository A frame class for graph nodes representing repository items.
interface	RepositoryDescription Frame class representing the description of a repository.
interface	UnknownProperty Holds information about the collection or institute, but we don't specify (in the database) what it exactly means.
interface	UserProfile A frame class representing a user within the database.
interface	VirtualUnit Virtual documentary unit.

Classes in eu.ehri.project.models that implement Entity

Modifier and Type	Class and Description
static class	Country.Impl Implementation of complex methods.
static class	DocumentaryUnit.Impl Implementation of complex methods.
static class	Group.Impl Implementation of complex methods.
static class	Repository.Impl Implementation of complex methods.
static class	UserProfile.Impl
static class	VirtualUnit.Impl Implementation of complex methods.

Methods in eu.ehri.project.models that return types with arguments of type Entity

Modifier and Type	Method and Description
Class<? extends Entity>	EntityClass.getJavaClass() Get the interface to which this EntityType refers.

Uses of Entity in eu.ehri.project.models.base

Subinterfaces of Entity in eu.ehri.project.models.base

Modifier and Type	Interface and Description
interface	AbstractUnit An abstract entity representing either a documentary (physical) unit or a virtual unit.
interface	Accessible An entity that can be accessed by specific Accessors.
interface	Accessor An entity that can access items and be granted permissions.
interface	Actioner An entity whose actions are recorded.
interface	Annotatable An entity that can be annotated.
interface	Annotator An entity that can annotate Annotatable items.
interface	Described An entity that can have descriptions.
interface	Description An entity that describes another entity.
interface	Identifiable Base interface for entities that have an identifier property (other than the internally assigned node ID).
interface	Linkable An entity that can hold incoming links.
interface	Named An entity that has a name.
interface	PermissionGrantTarget An entity that can be the target of a permission grant.
interface	PermissionScope The scope of permissions granted to users.
interface	Promotable An entity that can be promoted and demoted.
interface	Temporal An entity that can have one or more date periods attached.
interface	Versioned An entity that may have prior versions.
interface	Watchable An entity that can be watched by users.

Classes in eu.ehri.project.models.base that implement Entity

Modifier and Type	Class and Description
static class	Accessible.Impl Implementation of complex methods.
static class	Accessor.Impl
static class	Actioner.Impl Implementation of complex methods.
static class	Entity.Impl
static class	PermissionScope.Impl
static class	Promotable.Impl Implementation of complex methods.
static class	Versioned.Impl
static class	Watchable.Impl

Methods in eu.ehri.project.models.base with type parameters of type Entity

Modifier and Type	Method and Description
<T extends Entity> T	Entity.as(Class<T> cls) Cast this frame to another type.
<T extends Entity> T	Entity.Impl.as(Class<T> cls)

Uses of Entity in eu.ehri.project.models.cvoc

Subinterfaces of Entity in eu.ehri.project.models.cvoc

Modifier and Type	Interface and Description
interface	AuthoritativeItem An item that belongs in some authoritative set.
interface	AuthoritativeSet A frame class representing a item that holds other authoritative items, such as concepts and historical agents.
interface	Concept This models the thesaurus terms or keywords in a way that is better managing multi-linguality.
interface	ConceptDescription Description for a SKOS concept.
interface	Vocabulary A collection of 'related' concepts, or maybe a bit like the SKOS Concept Scheme Note that any concept in this Vocabulary that has no parent might be considered a topConcept.

Classes in eu.ehri.project.models.cvoc that implement Entity

Modifier and Type	Class and Description
static class	AuthoritativeSet.Impl Implementation of complex methods.
static class	Concept.Impl Implementation of complex methods.

Uses of Entity in eu.ehri.project.models.events

Subinterfaces of Entity in eu.ehri.project.models.events

Modifier and Type	Interface and Description
interface	EventLink
interface	SystemEvent Frame class representing an event that happened in the graph.
interface	SystemEventQueue Class representing the system event queue node, of which there Will Be Only One.
interface	Version Frame class representing a serialized version of some other node.

Classes in eu.ehri.project.models.events that implement Entity

Modifier and Type	Class and Description
static class	SystemEvent.Impl Implementation of complex methods.
static class	SystemEventQueue.Impl
static class	Version.Impl Implementation of complex methods.

Methods in eu.ehri.project.models.events that return Entity

Modifier and Type	Method and Description
Entity	SystemEvent.getEventScope() Fetch the "scope" of this event, or the context in which a given creation/modification/deletion event is happening.

Methods in eu.ehri.project.models.events with parameters of type Entity

Modifier and Type	Method and Description
void	SystemEvent.setEventScope(Entity frame) Set the scope of this event.

Uses of Entity in eu.ehri.project.persistence

Methods in eu.ehri.project.persistence with type parameters of type Entity

Modifier and Type	Method and Description
<T extends Entity> T	BundleManager.create(Bundle bundle, Class<T> cls) Entry-point for creating a bundle.
<T extends Entity> Mutation<T>	BundleManager.createOrUpdate(Bundle bundle, Class<T> cls) Entry point for creating or updating a bundle, depending on whether it has a supplied id.
<T extends Entity> Bundle	Serializer.entityToBundle(T item) Convert an Entity into a Bundle that includes its @Fetch'd relations.
<T extends Entity> Map<String,Object>	Serializer.entityToData(T item) Convert a vertex frame to a raw bundle of data.
<T extends Entity> String	Serializer.entityToJson(T item) Serialise a vertex frame to JSON.
<T extends Entity> void	Serializer.traverseSubtree(T item, TraversalCallback cb) Run a callback every time a node in a subtree is encountered, excepting the top-level node.
<T extends Entity> Mutation<T>	BundleManager.update(Bundle bundle, Class<T> cls) Entry-point for updating a bundle.

Methods in eu.ehri.project.persistence with parameters of type Entity

Modifier and Type	Method and Description
ActionManager.EventContext	ActionManager.EventContext.createVersion(Entity frame) Create a snapshot of the given node's data.
ActionManager.EventContext	ActionManager.EventContext.createVersion(Entity frame, Bundle bundle) Create a snapshot of the given node using the provided data.
void	TraversalCallback.process(Entity vertexFrame, int depth, String relation, int relationIndex)
ActionManager	ActionManager.setScope(Entity frame) Set the scope of this action.

Constructors in eu.ehri.project.persistence with parameters of type Entity

Constructor and Description
ActionManager(com.tinkerpop.frames.FramedGraph<?> graph, Entity scope) Constructor with scope.

Uses of Entity in eu.ehri.project.tools

Method parameters in eu.ehri.project.tools with type arguments of type Entity

Modifier and Type	Method and Description
List<List<String>>	IdRegenerator.reGenerateIds(PermissionScope scope, Iterable<? extends Entity> items)