net.cnri.repository.android

Class EmbeddedRepository

java.lang.Object

net.cnri.repository.AbstractRepository

net.cnri.repository.android.EmbeddedRepository

All Implemented Interfaces:

SupportsSearchExcluding, Repository

Direct Known Subclasses:

ClientRepository

public class EmbeddedRepository
extends AbstractRepository
implements Repository, SupportsSearchExcluding

Implements the Repository interface by writing data to an Android ContentProvider backed by an SQLite database. Allows you to create a Repository on an Android device.

Constructor Summary

Constructors

Constructor and Description
EmbeddedRepository(android.content.Context context, java.lang.String authority) Creates an EmbeddedRepository pointing to a specific content provider specified by its authority.

Method Summary

Methods

Modifier and Type	Method and Description
android.os.Bundle	call(java.lang.String method, java.lang.String arg, android.os.Bundle extras)
void	close() Close the repository and release all resources.
DigitalObject	createDigitalObject(java.lang.String handle) Creates a new digital object with the given identifier in this repository.
void	deleteDigitalObject(java.lang.String handle) Deletes a digital object from the repository.
DigitalObject	getDigitalObject(java.lang.String handle) Returns the digital object with the given identifier from this repository.
static Repository	getEmbeddedRepository(android.content.Context context) Creates a repository used to access the embedded repository on the Android device.
CloseableIterator<java.lang.String>	listHandles() Provides a CloseableIterator view of the identifiers for digital objects accessible through this repository.
CloseableIterator<DigitalObject>	listObjects() Provides a CloseableIterator view of the digital objects accessible through this repository.
CloseableIterator<DigitalObject>	search(Query query) Provides a CloseableIterator view of the digital objects accessible through this repository under search bounds defined in the Query object with default parameters.
CloseableIterator<DigitalObject>	searchExcluding(Query query, java.util.Collection<java.lang.String> handles)
CloseableIterator<java.lang.String>	searchHandles(Query query) Provides a CloseableIterator view of the digital objects handles accessible through this repository under search bounds defined in the Query object with default parameters.
CloseableIterator<java.lang.String>	searchHandlesExcluding(Query query, java.util.Collection<java.lang.String> handles)
void	setContext(android.content.Context context)
boolean	verifyDigitalObject(java.lang.String handle) Verifies whether a digital object with the given identifier can be accessed via this repository.

Methods inherited from class net.cnri.repository.AbstractRepository

getHandle, getOrCreateDigitalObject, search, search, searchHandles, searchHandles, searchMapping

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.cnri.repository.Repository

getHandle, getOrCreateDigitalObject, search, search, searchHandles, searchHandles, searchMapping

Constructor Detail

EmbeddedRepository

public EmbeddedRepository(android.content.Context context,
                  java.lang.String authority)
                   throws RepositoryException

Creates an EmbeddedRepository pointing to a specific content provider specified by its authority. Prefer getEmbeddedRepository(Context) to use the default provider.

Parameters:

authority -

Throws:

RepositoryException

Method Detail

getEmbeddedRepository

public static Repository getEmbeddedRepository(android.content.Context context)
                                        throws RepositoryException

Creates a repository used to access the embedded repository on the Android device.

Parameters:

context - the context of the Android application environment in which the repository will be accessed

Returns:

a new Repository instance

Throws:

RepositoryException

setContext

public void setContext(android.content.Context context)
                throws RepositoryException

Throws:

RepositoryException

verifyDigitalObject

public boolean verifyDigitalObject(java.lang.String handle)
                            throws RepositoryException

Description copied from interface: Repository

Verifies whether a digital object with the given identifier can be accessed via this repository.

Specified by:

verifyDigitalObject in interface Repository

Overrides:

verifyDigitalObject in class AbstractRepository

Parameters:

handle - an identifier for a digital object

Returns:

whether a digital object with that identifier can be accessed via this repository

Throws:

RepositoryException

createDigitalObject

public DigitalObject createDigitalObject(java.lang.String handle)
                                  throws CreationException,
                                         RepositoryException

Description copied from interface: Repository

Creates a new digital object with the given identifier in this repository. Passing null requests that the repository assign a new unique identifier; this method will throw UnsupportedOperationException if the given repository does not support that functionality.

Specified by:

createDigitalObject in interface Repository

Parameters:

handle - the identifier for the new digital object, or null to request that the repository assign a new unique identifier.

Returns:

the newly-created digital object

Throws:

CreationException - if an object with the given identifier already exists within the repository

RepositoryException

getDigitalObject

public DigitalObject getDigitalObject(java.lang.String handle)
                               throws RepositoryException

Description copied from interface: Repository

Returns the digital object with the given identifier from this repository.

Specified by:

getDigitalObject in interface Repository

Parameters:

handle - the identifier for the digital object

Returns:

the digital object, or null if no such object can be accessed through this repository

Throws:

RepositoryException

deleteDigitalObject

public void deleteDigitalObject(java.lang.String handle)
                         throws RepositoryException

Description copied from interface: Repository

Deletes a digital object from the repository.

Specified by:

deleteDigitalObject in interface Repository

Overrides:

deleteDigitalObject in class AbstractRepository

Parameters:

handle - the identifier for the digital object

Throws:

RepositoryException

listHandles

public CloseableIterator<java.lang.String> listHandles()
                                                throws RepositoryException

Description copied from interface: Repository

Provides a CloseableIterator view of the identifiers for digital objects accessible through this repository.

Specified by:

listHandles in interface Repository

Overrides:

listHandles in class AbstractRepository

Throws:

RepositoryException

listObjects

public CloseableIterator<DigitalObject> listObjects()
                                             throws RepositoryException

Description copied from interface: Repository

Provides a CloseableIterator view of the digital objects accessible through this repository.

Specified by:

listObjects in interface Repository

Overrides:

listObjects in class AbstractRepository

Throws:

RepositoryException

searchExcluding

public CloseableIterator<DigitalObject> searchExcluding(Query query,
                                               java.util.Collection<java.lang.String> handles)
                                                 throws RepositoryException

Specified by:

searchExcluding in interface SupportsSearchExcluding

Throws:

RepositoryException

search

public CloseableIterator<DigitalObject> search(Query query)
                                        throws RepositoryException

Description copied from interface: Repository

Provides a CloseableIterator view of the digital objects accessible through this repository under search bounds defined in the Query object with default parameters.

Specified by:

search in interface Repository

Overrides:

search in class AbstractRepository

Parameters:

query - the query to perform

Returns:

a CloseableIterator over the results. Some implementations may return QueryResults.

Throws:

RepositoryException

searchHandles

public CloseableIterator<java.lang.String> searchHandles(Query query)
                                                  throws RepositoryException

Description copied from interface: Repository

Provides a CloseableIterator view of the digital objects handles accessible through this repository under search bounds defined in the Query object with default parameters.

Specified by:

searchHandles in interface Repository

Overrides:

searchHandles in class AbstractRepository

Parameters:

query - the query to perform

Returns:

a CloseableIterator over the results. Some implementations may return QueryResults.

Throws:

RepositoryException

searchHandlesExcluding

public CloseableIterator<java.lang.String> searchHandlesExcluding(Query query,
                                                         java.util.Collection<java.lang.String> handles)
                                                           throws RepositoryException

Specified by:

searchHandlesExcluding in interface SupportsSearchExcluding

Throws:

RepositoryException

close

public void close()

Description copied from interface: Repository

Close the repository and release all resources.

Specified by:

close in interface Repository

call

public android.os.Bundle call(java.lang.String method,
                     java.lang.String arg,
                     android.os.Bundle extras)
                       throws RepositoryException

Throws:

RepositoryException