eu.ehri.project.models.base

Interface Entity

All Superinterfaces:

com.tinkerpop.frames.VertexFrame

All Known Subinterfaces:

AbstractUnit, Accessible, Accessor, AccessPoint, Actioner, Address, Annotatable, Annotation, Annotator, AuthoritativeItem, AuthoritativeSet, Concept, ConceptDescription, ContentType, Country, DatePeriod, Described, Description, DocumentaryUnit, DocumentaryUnitDescription, EventLink, Group, HistoricalAgent, HistoricalAgentDescription, Identifiable, Link, Linkable, MaintenanceEvent, Named, Permission, PermissionGrant, PermissionGrantTarget, PermissionScope, Promotable, Repository, RepositoryDescription, SystemEvent, SystemEventQueue, Temporal, UnknownProperty, UserProfile, Version, Versioned, VirtualUnit, Vocabulary, Watchable

All Known Implementing Classes:

Accessible.Impl, Accessor.Impl, Actioner.Impl, AnonymousAccessor, AuthoritativeSet.Impl, Concept.Impl, Country.Impl, DocumentaryUnit.Impl, Entity.Impl, Group.Impl, PermissionScope.Impl, Promotable.Impl, Repository.Impl, SystemEvent.Impl, SystemEventQueue.Impl, SystemScope, UserProfile.Impl, Version.Impl, Versioned.Impl, VirtualUnit.Impl, Watchable.Impl

public interface Entity
extends com.tinkerpop.frames.VertexFrame

Base interface for all EHRI framed vertex types.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Entity.Impl

Method Summary

Modifier and Type	Method and Description
<T extends Entity> T	as(Class<T> cls) Cast this frame to another type.
String	getId() Get the unique item id.
<T> T	getProperty(Enum<?> key)
<T> T	getProperty(String key) Get an arbitrary property from the underlying vertex.
Set<String>	getPropertyKeys() Get the property keys from the underlying vertex.
String	getType() Get the type key for this frame.

Methods inherited from interface com.tinkerpop.frames.VertexFrame

asVertex

Method Detail

as

<T extends Entity> T as(Class<T> cls)

Cast this frame to another type.

Type Parameters:

T - the generic class

Parameters:

cls - the class of the framed type

Returns:

the framed item as the new class

getId

String getId()

Get the unique item id.

Returns:

id

getType

String getType()

Get the type key for this frame.

Returns:

type

getProperty

<T> T getProperty(String key)

Get an arbitrary property from the underlying vertex.

Type Parameters:

T - the property's type

Parameters:

key - the property key

Returns:

the property value, or null

getProperty

<T> T getProperty(Enum<?> key)

getPropertyKeys

Set<String> getPropertyKeys()

Get the property keys from the underlying vertex.

Returns:

a set of string keys