Uses of Class
eu.ehri.project.persistence.Bundle

Packages that use Bundle

Package	Description
eu.ehri.extension	Jersey resource classes for providing web service access to the graph, via the eu.ehri.project.api layer.
eu.ehri.extension.base
eu.ehri.extension.providers
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.commands	Classes that represent actions that can be run via the CmdEntryPoint to manage the graph, e.g.
eu.ehri.project.exceptions
eu.ehri.project.importers.ead
eu.ehri.project.models.idgen	Classes that handle the generation of string identifiers for different kinds of resource.
eu.ehri.project.persistence	Classes dealing with persistence of relational item data in sub-tree format.

Uses of Bundle in eu.ehri.extension

Methods in eu.ehri.extension with parameters of type Bundle

Modifier and Type	Method and Description
javax.ws.rs.core.Response	CountryResource.create(Bundle bundle, List<String> accessors)
javax.ws.rs.core.Response	AuthoritativeSetResource.create(Bundle bundle, List<String> accessors)
javax.ws.rs.core.Response	VocabularyResource.create(Bundle bundle, List<String> accessors)
javax.ws.rs.core.Response	HistoricalAgentResource.create(Bundle bundle, List<String> accessors)
javax.ws.rs.core.Response	LinkResource.create(Bundle bundle, String source, String target, List<String> bodies, List<String> accessors) Create a link between two items.
javax.ws.rs.core.Response	GenericResource.createAccessPoint(String id, String did, Bundle bundle) Create an access point on the given description, for the given parent item.
javax.ws.rs.core.Response	AnnotationResource.createAnnotation(String id, String did, List<String> accessors, Bundle bundle) Create an annotation for a particular item.
javax.ws.rs.core.Response	CountryResource.createChild(String id, Bundle bundle, List<String> accessors) Create a top-level repository unit for this country.
javax.ws.rs.core.Response	AuthoritativeSetResource.createChild(String id, Bundle bundle, List<String> accessors)
javax.ws.rs.core.Response	VocabularyResource.createChild(String id, Bundle bundle, List<String> accessors)
javax.ws.rs.core.Response	CvocConceptResource.createChild(String id, Bundle bundle, List<String> accessors)
javax.ws.rs.core.Response	RepositoryResource.createChild(String id, Bundle bundle, List<String> accessors) Create a documentary unit for this repository.
javax.ws.rs.core.Response	DocumentaryUnitResource.createChild(String id, Bundle bundle, List<String> accessors)
javax.ws.rs.core.Response	VirtualUnitResource.createChildVirtualUnit(String id, Bundle bundle, List<String> accessors, List<String> includedIds)
javax.ws.rs.core.Response	GenericResource.createDescription(String id, Bundle bundle) Create a new description for this item.
javax.ws.rs.core.Response	GroupResource.createGroup(Bundle bundle, List<String> accessors, List<String> members)
javax.ws.rs.core.Response	VirtualUnitResource.createTopLevelVirtualUnit(Bundle bundle, List<String> accessors, List<String> includedIds)
javax.ws.rs.core.Response	UserProfileResource.createUserProfile(Bundle bundle, List<String> groupIds, List<String> accessors)
javax.ws.rs.core.Response	GroupResource.update(String id, Bundle bundle)
javax.ws.rs.core.Response	CountryResource.update(String id, Bundle bundle)
javax.ws.rs.core.Response	AnnotationResource.update(String id, Bundle bundle)
javax.ws.rs.core.Response	AuthoritativeSetResource.update(String id, Bundle bundle)
javax.ws.rs.core.Response	VocabularyResource.update(String id, Bundle bundle)
javax.ws.rs.core.Response	CvocConceptResource.update(String id, Bundle bundle)
javax.ws.rs.core.Response	LinkResource.update(String id, Bundle bundle)
javax.ws.rs.core.Response	RepositoryResource.update(String id, Bundle bundle)
javax.ws.rs.core.Response	DocumentaryUnitResource.update(String id, Bundle bundle)
javax.ws.rs.core.Response	VirtualUnitResource.update(String id, Bundle bundle)
javax.ws.rs.core.Response	HistoricalAgentResource.update(String id, Bundle bundle)
javax.ws.rs.core.Response	UserProfileResource.update(String id, Bundle bundle)
javax.ws.rs.core.Response	GenericResource.updateDescription(String id, Bundle bundle) Update a description belonging to the given item.
javax.ws.rs.core.Response	GenericResource.updateDescriptionWithId(String id, String did, Bundle bundle) Update a description with the given ID, belonging to the given parent item.

Uses of Bundle in eu.ehri.extension.base

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

Modifier and Type	Method and Description
javax.ws.rs.core.Response	CreateResource.create(Bundle bundle, List<String> accessors) Create a resource.
javax.ws.rs.core.Response	ParentResource.createChild(String id, Bundle bundle, List<String> accessors) Create a subordinate resource.
javax.ws.rs.core.Response	AbstractAccessibleResource.createItem(Bundle entityBundle, List<String> accessorIds)
javax.ws.rs.core.Response	AbstractAccessibleResource.createItem(Bundle entityBundle, List<String> accessorIds, AbstractAccessibleResource.Handler<E> handler) Create an instance of the 'entity' in the database
<T extends Accessible> javax.ws.rs.core.Response	AbstractAccessibleResource.createItem(Bundle entityBundle, List<String> accessorIds, AbstractAccessibleResource.Handler<T> handler, Api scopedApi, Class<T> otherCls) Create an instance of the 'entity' in the database
javax.ws.rs.core.Response	UpdateResource.update(String id, Bundle bundle) Update a resource.
javax.ws.rs.core.Response	AbstractAccessibleResource.updateItem(Bundle entityBundle) Update (change) an instance of the 'entity' in the database.
javax.ws.rs.core.Response	AbstractAccessibleResource.updateItem(String id, Bundle rawBundle) Update (change) an instance of the 'entity' in the database

Uses of Bundle in eu.ehri.extension.providers

Methods in eu.ehri.extension.providers that return Bundle

Modifier and Type	Method and Description
Bundle	BundleProvider.readFrom(Class<Bundle> bundleClass, Type type, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,String> headers, InputStream stream)

Methods in eu.ehri.extension.providers with parameters of type Bundle

Modifier and Type	Method and Description
long	BundleProvider.getSize(Bundle bundle, Class<?> aClass, Type type, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)
void	BundleProvider.writeTo(Bundle bundle, Class<?> aClass, Type type, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,Object> multivaluedMap, OutputStream outputStream)

Method parameters in eu.ehri.extension.providers with type arguments of type Bundle

Modifier and Type	Method and Description
Bundle	BundleProvider.readFrom(Class<Bundle> bundleClass, Type type, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,String> headers, InputStream stream)

Uses of Bundle in eu.ehri.project.api

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

Modifier and Type	Method and Description
<E extends Accessible> E	Api.create(Bundle bundle, Class<E> cls) Create a new object of type `E` from the given data, within the scope of `scope`.
<E extends Accessible> E	Api.create(Bundle bundle, Class<E> cls, Optional<String> logMessage) Create a new object of type `E` from the given data, saving an Action log with the given log message.
Link	Api.createAccessPointLink(String targetId1, String targetId2, String descriptionId, String bodyName, AccessPointType bodyType, Bundle bundle, Collection<Accessor> accessibleTo, Optional<String> logMessage) Create a link between two items, along with an access point on the given description.
Annotation	Api.createAnnotation(String id, String did, Bundle bundle, Collection<Accessor> accessibleTo, Optional<String> logMessage) Create an annotation for a dependent node of an item.
<T extends Accessible> T	Api.createDependent(String parentId, Bundle data, Class<T> cls, Optional<String> logMessage) Create a dependent item, belonging to the given parent.
Link	Api.createLink(String targetId1, String targetId2, List<String> bodies, Bundle bundle, Collection<Accessor> accessibleTo, Optional<String> logMessage) Create a link between two items.
<E extends Accessible> Mutation<E>	Api.createOrUpdate(Bundle bundle, Class<E> cls) Create or update a new object of type `E` from the given data, within the scope of `scope`.
<E extends Accessible> Mutation<E>	Api.createOrUpdate(Bundle bundle, Class<E> cls, Optional<String> logMessage) Create or update a new object of type `E` from the given data, within the scope of `scope`.
<E extends Accessible> Mutation<E>	Api.update(Bundle bundle, Class<E> cls) Update an object bundle, also updating dependent items.
<E extends Accessible> Mutation<E>	Api.update(Bundle bundle, Class<E> cls, Optional<String> logMessage) Create or update a new object of type `E` from the given data, saving an Action log with the given log message.
<T extends Accessible> Mutation<T>	Api.updateDependent(String parentId, Bundle data, Class<T> cls, Optional<String> logMessage) Update a dependent item, belonging to the given parent.

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

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

Modifier and Type	Method and Description
<E extends Accessible> E	ApiImpl.create(Bundle bundle, Class<E> cls)
<E extends Accessible> E	ApiImpl.create(Bundle bundle, Class<E> cls, Optional<String> logMessage)
Link	ApiImpl.createAccessPointLink(String targetId1, String targetId2, String descriptionId, String bodyName, AccessPointType bodyType, Bundle bundle, Collection<Accessor> accessibleTo, Optional<String> logMessage)
Annotation	ApiImpl.createAnnotation(String id, String did, Bundle bundle, Collection<Accessor> accessibleTo, Optional<String> logMessage)
<T extends Accessible> T	ApiImpl.createDependent(String parentId, Bundle data, Class<T> cls, Optional<String> logMessage)
Link	ApiImpl.createLink(String targetId1, String targetId2, List<String> bodies, Bundle bundle, Collection<Accessor> accessibleTo, Optional<String> logMessage)
<E extends Accessible> Mutation<E>	ApiImpl.createOrUpdate(Bundle bundle, Class<E> cls)
<E extends Accessible> Mutation<E>	ApiImpl.createOrUpdate(Bundle bundle, Class<E> cls, Optional<String> logMessage)
<E extends Accessible> Mutation<E>	ApiImpl.update(Bundle bundle, Class<E> cls)
<E extends Accessible> Mutation<E>	ApiImpl.update(Bundle bundle, Class<E> cls, Optional<String> logMessage)
<T extends Accessible> Mutation<T>	ApiImpl.updateDependent(String parentId, Bundle data, Class<T> cls, Optional<String> logMessage)

Uses of Bundle in eu.ehri.project.commands

Methods in eu.ehri.project.commands with parameters of type Bundle

Modifier and Type	Method and Description
void	EntityAdd.createItem(com.tinkerpop.frames.FramedGraph<?> graph, org.apache.commons.cli.CommandLine cmdLine, String id, Bundle bundle, PermissionScope scope, UserProfile user, String logMessage)

Uses of Bundle in eu.ehri.project.exceptions

Methods in eu.ehri.project.exceptions that return Bundle

Modifier and Type	Method and Description
Bundle	ValidationError.getBundle()

Constructors in eu.ehri.project.exceptions with parameters of type Bundle

Constructor and Description
ValidationError(Bundle bundle, ErrorSet errorSet)
ValidationError(Bundle bundle, com.google.common.collect.ListMultimap<String,String> errors)
ValidationError(Bundle bundle, String key, String error)

Uses of Bundle in eu.ehri.project.importers.ead

Methods in eu.ehri.project.importers.ead that return Bundle

Modifier and Type	Method and Description
protected Bundle	EadImporter.getDescription(Map<String,Object> itemData) Extract the documentary unit description bundle from the raw map data.
protected Bundle	EadImporter.mergeWithPreviousAndSave(Bundle unit, Bundle descBundle, List<String> idPath) Finds any bundle in the graph with the same ObjectIdentifier.

Methods in eu.ehri.project.importers.ead with parameters of type Bundle

Modifier and Type	Method and Description
protected Bundle	EadImporter.mergeWithPreviousAndSave(Bundle unit, Bundle descBundle, List<String> idPath) Finds any bundle in the graph with the same ObjectIdentifier.

Uses of Bundle in eu.ehri.project.models.idgen

Methods in eu.ehri.project.models.idgen with parameters of type Bundle

Modifier and Type	Method and Description
String	IdentifiableEntityIdGenerator.generateId(Collection<String> scopeIds, Bundle bundle) Use an array of scope IDs and the bundle data to generate a unique id within a given scope.
String	IdGenerator.generateId(Collection<String> scopeIds, Bundle bundle) Generate an ID given an array of scope IDs.
String	GenericIdGenerator.generateId(Collection<String> scopeIds, Bundle bundle) Generates a random String.
String	DescriptionIdGenerator.generateId(Collection<String> scopeIds, Bundle bundle) Use an array of scope IDs and the bundle data to generate a unique id within a given scope.
static String	IdGeneratorUtils.generateId(Collection<String> scopeIds, Bundle bundle, String ident) Use an array of scope IDs and the bundle data to generate a unique id within a given scope.
static String	IdGeneratorUtils.generateId(PermissionScope scope, Bundle bundle, String ident) Uses the items identifier and its entity type to generate a (supposedly) unique ID.
String	IdentifiableEntityIdGenerator.getIdBase(Bundle bundle) Return the base data for the id, sans scoping.
String	IdGenerator.getIdBase(Bundle bundle) Return the base data for the id, sans scoping.
String	GenericIdGenerator.getIdBase(Bundle bundle) Return the base data for the id, sans scoping.
String	DescriptionIdGenerator.getIdBase(Bundle bundle) Return the base data for the id, sans scoping.
com.google.common.collect.ListMultimap<String,String>	IdentifiableEntityIdGenerator.handleIdCollision(Collection<String> scopeIds, Bundle bundle)
com.google.common.collect.ListMultimap<String,String>	IdGenerator.handleIdCollision(Collection<String> scopeIds, Bundle bundle)
com.google.common.collect.ListMultimap<String,String>	GenericIdGenerator.handleIdCollision(Collection<String> scopeIds, Bundle bundle)
com.google.common.collect.ListMultimap<String,String>	DescriptionIdGenerator.handleIdCollision(Collection<String> scopeIds, Bundle bundle)

Uses of Bundle in eu.ehri.project.persistence

Methods in eu.ehri.project.persistence that return Bundle

Modifier and Type	Method and Description
Bundle	Bundle.Builder.build()
Bundle	Bundle.dependentsOnly() Return a bundle consisting of only dependent relations.
Bundle	BundleDeserializer.deserialize(com.fasterxml.jackson.core.JsonParser parser, com.fasterxml.jackson.databind.DeserializationContext context)
<T extends Entity> Bundle	Serializer.entityToBundle(T item) Convert an Entity into a Bundle that includes its @Fetch'd relations.
Bundle	Bundle.filterRelations(BiPredicate<String,Bundle> filter) Filter relations, removing items that *match* the given filter function.
static Bundle	Bundle.fromData(Object data) Create a bundle from raw data.
static Bundle	Bundle.fromStream(InputStream stream) Create a bundle from a stream containing JSON data..
static Bundle	Bundle.fromString(String json) Create a bundle from a (JSON) string.
Bundle	Bundle.generateIds(Collection<String> scopes) Generate missing IDs for the subtree.
Bundle	Bundle.map(Function<Bundle,Bundle> f) Run a function transforming all items in the bundle, including the top level, returning a new bundle.
Bundle	Bundle.mergeDataWith(Bundle otherBundle) Merge this bundle's data with that of another.
static Bundle	Bundle.of(EntityClass type) Constructor for just a type.
static Bundle	Bundle.of(EntityClass type, Map<String,Object> data) Constructor for bundle without existing id or relations.
static Bundle	Bundle.of(EntityClass type, Map<String,Object> data, com.google.common.collect.Multimap<String,Bundle> relations) Factory for bundle without existing id.
static Bundle	Bundle.of(String id, EntityClass type, Map<String,Object> data, com.google.common.collect.Multimap<String,Bundle> relations) Factory for bundle without existing id.
static Bundle	Bundle.of(String id, EntityClass type, Map<String,Object> data, com.google.common.collect.Multimap<String,Bundle> relations, Map<String,Object> meta) Factory.
Bundle	Bundle.removeDataValue(String key) Remove a value in the bundle's data.
Bundle	Bundle.removeRelation(String relation, Bundle item) Remove a single relation.
Bundle	Bundle.replaceRelations(com.google.common.collect.Multimap<String,Bundle> relations) Set entire set of relations.
Bundle	Serializer.vertexToBundle(com.tinkerpop.blueprints.Vertex item) Convert a Vertex into a Bundle that includes its @Fetch'd relations.
Bundle	Bundle.withData(Map<String,Object> data) Set the entire data map for this bundle.
Bundle	Bundle.withDataValue(String key, Object value) Set a value in the bundle's data.
Bundle	Bundle.withId(String id) Get a bundle with the given id.
Bundle	Bundle.withMetaData(Map<String,Object> meta) Set the entire meta data map for this bundle.
Bundle	Bundle.withMetaDataValue(String key, Object value) Set a value in the bundle's meta data.
Bundle	Bundle.withRelation(String relation, Bundle other) Add a bundle for a particular relation.
Bundle	Bundle.withRelations(com.google.common.collect.Multimap<String,Bundle> others) Add a map of addition relationships.
Bundle	Bundle.withRelations(String relation, List<Bundle> others) Set bundles for a particular relation.

Methods in eu.ehri.project.persistence that return types with arguments of type Bundle

Modifier and Type	Method and Description
static com.tinkerpop.blueprints.CloseableIterable<Bundle>	Bundle.bundleStream(InputStream inputStream)
Optional<Bundle>	Bundle.find(Predicate<Bundle> f)
com.google.common.collect.Multimap<String,Bundle>	Bundle.getDependentRelations() Get only the bundle's relations which have a dependent relationship.
Optional<Bundle>	Mutation.getPrior()
com.google.common.collect.Multimap<String,Bundle>	Bundle.getRelations() Get the bundle's relation bundles.
List<Bundle>	Bundle.getRelations(String relation) Get a set of relations.

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

Modifier and Type	Method and Description
Bundle.Builder	Bundle.Builder.addRelation(String relation, Bundle bundle)
<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.
ActionManager.EventContext	ActionManager.EventContext.createVersion(Entity frame, Bundle bundle) Create a snapshot of the given node using the provided data.
int	BundleManager.delete(Bundle bundle) Delete a bundle and dependent items, returning the total number of vertices deleted.
String	Bundle.diff(Bundle target) Return a JSON-Patch representation of the difference between this bundle and another.
static Bundle.Builder	Bundle.Builder.from(Bundle bundle)
Bundle	Bundle.mergeDataWith(Bundle otherBundle) Merge this bundle's data with that of another.
Bundle	Bundle.removeRelation(String relation, Bundle item) Remove a single relation.
static void	Bundle.toStream(Bundle bundle, OutputStream stream) Write a bundle to a JSON stream.
<T extends Entity> Mutation<T>	BundleManager.update(Bundle bundle, Class<T> cls) Entry-point for updating a bundle.
Bundle	Bundle.withRelation(String relation, Bundle other) Add a bundle for a particular relation.

Method parameters in eu.ehri.project.persistence with type arguments of type Bundle

Modifier and Type	Method and Description
Bundle.Builder	Bundle.Builder.addRelations(com.google.common.collect.Multimap<String,Bundle> r)
Bundle	Bundle.filterRelations(BiPredicate<String,Bundle> filter) Filter relations, removing items that *match* the given filter function.
Optional<Bundle>	Bundle.find(Predicate<Bundle> f)
boolean	Bundle.forAny(Predicate<Bundle> f) Test if a predicate function holds true for any item in the bundle, including the top level.
Bundle	Bundle.map(Function<Bundle,Bundle> f) Run a function transforming all items in the bundle, including the top level, returning a new bundle.
Bundle	Bundle.map(Function<Bundle,Bundle> f) Run a function transforming all items in the bundle, including the top level, returning a new bundle.
static Bundle	Bundle.of(EntityClass type, Map<String,Object> data, com.google.common.collect.Multimap<String,Bundle> relations) Factory for bundle without existing id.
static Bundle	Bundle.of(String id, EntityClass type, Map<String,Object> data, com.google.common.collect.Multimap<String,Bundle> relations) Factory for bundle without existing id.
static Bundle	Bundle.of(String id, EntityClass type, Map<String,Object> data, com.google.common.collect.Multimap<String,Bundle> relations, Map<String,Object> meta) Factory.
Bundle	Bundle.replaceRelations(com.google.common.collect.Multimap<String,Bundle> relations) Set entire set of relations.
Bundle	Bundle.withRelations(com.google.common.collect.Multimap<String,Bundle> others) Add a map of addition relationships.
Bundle	Bundle.withRelations(String relation, List<Bundle> others) Set bundles for a particular relation.

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

Constructor and Description
Mutation(T node, MutationState state, Bundle bundle)

Constructor parameters in eu.ehri.project.persistence with type arguments of type Bundle

Constructor and Description
Mutation(T node, MutationState state, Optional<Bundle> prior)