com.arangodb.springframework.core.template

Class DefaultCollectionOperations

java.lang.Object

com.arangodb.springframework.core.template.DefaultCollectionOperations

All Implemented Interfaces:

CollectionOperations

public class DefaultCollectionOperations
extends Object
implements CollectionOperations

Author:

Mark Vollmary

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultCollectionOperations(com.arangodb.ArangoCollection collection, Map<com.arangodb.springframework.core.template.CollectionCacheKey,com.arangodb.springframework.core.template.CollectionCacheValue> collectionCache, PersistenceExceptionTranslator exceptionTranslator)

Method Summary

Modifier and Type	Method and Description
long	count() Counts the documents in a collection
void	drop() Deletes the collection from the database.
void	dropIndex(String id) Deletes the index with the given id from the collection.
com.arangodb.entity.IndexEntity	ensureFulltextIndex(Iterable<String> fields, com.arangodb.model.FulltextIndexOptions options) Creates a fulltext index for the collection, if it does not already exist.
com.arangodb.entity.IndexEntity	ensureGeoIndex(Iterable<String> fields, com.arangodb.model.GeoIndexOptions options) Creates a geo-spatial index for the collection, if it does not already exist.
com.arangodb.entity.IndexEntity	ensureHashIndex(Iterable<String> fields, com.arangodb.model.HashIndexOptions options) Creates a hash index for the collection if it does not already exist.
com.arangodb.entity.IndexEntity	ensurePersistentIndex(Iterable<String> fields, com.arangodb.model.PersistentIndexOptions options) Creates a persistent index for the collection, if it does not already exist.
com.arangodb.entity.IndexEntity	ensureSkiplistIndex(Iterable<String> fields, com.arangodb.model.SkiplistIndexOptions options) Creates a skip-list index for the collection, if it does not already exist.
Collection<com.arangodb.entity.IndexEntity>	getIndexes() Returns all indexes of the collection
com.arangodb.entity.Permissions	getPermissions(String username) Get the collection access level
com.arangodb.entity.CollectionPropertiesEntity	getProperties() Reads the properties of the specified collection
void	grantAccess(String username, com.arangodb.entity.Permissions permissions) Grants or revoke access to the collection for user user.
String	name() Return the collection name
void	resetAccess(String username) Clear the collection access level, revert back to the default access level.
void	truncate() Removes all documents from the collection, but leaves the indexes intact

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCollectionOperations

protected DefaultCollectionOperations(com.arangodb.ArangoCollection collection,
                                      Map<com.arangodb.springframework.core.template.CollectionCacheKey,com.arangodb.springframework.core.template.CollectionCacheValue> collectionCache,
                                      PersistenceExceptionTranslator exceptionTranslator)

Method Detail

name

public String name()

Description copied from interface: CollectionOperations

Return the collection name

Specified by:

name in interface CollectionOperations

Returns:

collection name

drop

public void drop()
          throws DataAccessException

Description copied from interface: CollectionOperations

Deletes the collection from the database.

Specified by:

drop in interface CollectionOperations

Throws:

DataAccessException

truncate

public void truncate()
              throws DataAccessException

Description copied from interface: CollectionOperations

Removes all documents from the collection, but leaves the indexes intact

Specified by:

truncate in interface CollectionOperations

Throws:

DataAccessException

count

public long count()
           throws DataAccessException

Description copied from interface: CollectionOperations

Counts the documents in a collection

Specified by:

count in interface CollectionOperations

Returns:

number of

Throws:

DataAccessException

getProperties

public com.arangodb.entity.CollectionPropertiesEntity getProperties()
                                                             throws DataAccessException

Description copied from interface: CollectionOperations

Reads the properties of the specified collection

Specified by:

getProperties in interface CollectionOperations

Returns:

properties of the collection

Throws:

DataAccessException

getIndexes

public Collection<com.arangodb.entity.IndexEntity> getIndexes()
                                                       throws DataAccessException

Description copied from interface: CollectionOperations

Returns all indexes of the collection

Specified by:

getIndexes in interface CollectionOperations

Returns:

information about the indexes

Throws:

DataAccessException

ensureHashIndex

public com.arangodb.entity.IndexEntity ensureHashIndex(Iterable<String> fields,
                                                       com.arangodb.model.HashIndexOptions options)
                                                throws DataAccessException

Description copied from interface: CollectionOperations

Creates a hash index for the collection if it does not already exist.

Specified by:

ensureHashIndex in interface CollectionOperations

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

Throws:

DataAccessException

ensureSkiplistIndex

public com.arangodb.entity.IndexEntity ensureSkiplistIndex(Iterable<String> fields,
                                                           com.arangodb.model.SkiplistIndexOptions options)
                                                    throws DataAccessException

Description copied from interface: CollectionOperations

Creates a skip-list index for the collection, if it does not already exist.

Specified by:

ensureSkiplistIndex in interface CollectionOperations

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

Throws:

DataAccessException

ensurePersistentIndex

public com.arangodb.entity.IndexEntity ensurePersistentIndex(Iterable<String> fields,
                                                             com.arangodb.model.PersistentIndexOptions options)
                                                      throws DataAccessException

Description copied from interface: CollectionOperations

Creates a persistent index for the collection, if it does not already exist.

Specified by:

ensurePersistentIndex in interface CollectionOperations

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

Throws:

DataAccessException

ensureGeoIndex

public com.arangodb.entity.IndexEntity ensureGeoIndex(Iterable<String> fields,
                                                      com.arangodb.model.GeoIndexOptions options)
                                               throws DataAccessException

Description copied from interface: CollectionOperations

Creates a geo-spatial index for the collection, if it does not already exist.

Specified by:

ensureGeoIndex in interface CollectionOperations

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

Throws:

DataAccessException

ensureFulltextIndex

public com.arangodb.entity.IndexEntity ensureFulltextIndex(Iterable<String> fields,
                                                           com.arangodb.model.FulltextIndexOptions options)
                                                    throws DataAccessException

Description copied from interface: CollectionOperations

Creates a fulltext index for the collection, if it does not already exist.

Specified by:

ensureFulltextIndex in interface CollectionOperations

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

Throws:

DataAccessException

dropIndex

public void dropIndex(String id)
               throws DataAccessException

Description copied from interface: CollectionOperations

Deletes the index with the given id from the collection.

Specified by:

dropIndex in interface CollectionOperations

Parameters:

id - The index-handle

Throws:

DataAccessException

grantAccess

public void grantAccess(String username,
                        com.arangodb.entity.Permissions permissions)

Description copied from interface: CollectionOperations

Grants or revoke access to the collection for user user. You need permission to the _system database in order to execute this call.

Specified by:

grantAccess in interface CollectionOperations

Parameters:

username - The name of the user

permissions - The permissions the user grant

resetAccess

public void resetAccess(String username)

Description copied from interface: CollectionOperations

Clear the collection access level, revert back to the default access level.

Specified by:

resetAccess in interface CollectionOperations

Parameters:

username - The name of the user

getPermissions

public com.arangodb.entity.Permissions getPermissions(String username)
                                               throws DataAccessException

Description copied from interface: CollectionOperations

Get the collection access level

Specified by:

getPermissions in interface CollectionOperations

Parameters:

username - The name of the user

Returns:

permissions of the user

Throws:

DataAccessException