| org.outerj.daisy.repository |
|
Core API for accessing the repository, and creating and modifying documents in it.
|
| Java Source File Name | Type | Comment |
| AccessException.java | Class | Exception thrown in case of permission-related problems. |
| AuthenticationFailedException.java | Class | |
| AvailableVariant.java | Interface | Holds information about a variant of a document. |
| AvailableVariants.java | Interface | |
| ByteArrayPartDataSource.java | Class | An implementation of the
PartDataSource interface that takes
its input from a byte array. |
| ChangeType.java | enum | Indicates if a
Version contains major or minor changes. |
| CollectionDeletedException.java | Class | Thrown if a collection has been removed at the same time someone was
editing a document that belonged to the removed collection. |
| CollectionManager.java | Interface | The CollectionManager is responsible for all tasks related
to collection management (creation, deletion, listing).
The CollectionManager can be retrieved via
Repository.getCollectionManager .
Collections are named sets of documents. |
| CollectionNotFoundException.java | Class | Thrown if a collection has been requested but it has not been found in the repository. |
| ConcurrentUpdateException.java | Class | A concurrent update happened to some repository-managed entity. |
| Credentials.java | Class | |
| Document.java | Interface | A document in the repository. |
| DocumentCollection.java | Interface | A collection of documents in the repository. |
| DocumentCollections.java | Interface | A collection of
DocumentCollection objects. |
| DocumentLockedException.java | Class | This exception is thrown when trying to save a document that is locked. |
| DocumentNotFoundException.java | Class | |
| DocumentReadDeniedException.java | Class | |
| DocumentTypeInconsistencyException.java | Class | This exception is used when manipulating a document in a way that would make
it inconsistent with its DocumentType. |
| DocumentVariantNotFoundException.java | Class | |
| Field.java | Interface | Fields belong to documents (or versions of documents), and can
be used for various purposes.
Often, fields will be used for meta-data about the document, though
you can use them for whatever data that you want to have addressable
on a finer level then that contained in the
Parts .
A field is always based upon a
org.outerj.daisy.repository.schema.FieldType ,
which defines the kind of data that the field can contain.
Note that a field has no setters methods, modifications can only
be done through the containing
Document . |
| FieldHelper.java | Class | Some helper methods that can be useful when working with
Field s. |
| FieldNotFoundException.java | Class | |
| Fields.java | Interface | A collection of
Field objects. |
| FilePartDataSource.java | Class | |
| HierarchyPath.java | Class | A HierarchyPath is the value assigned to a hierarchical field. |
| InvalidDocumentIdException.java | Class | |
| Link.java | Interface | An "out-of-line" link associated with a
Document or
Version . |
| LinkExtractorInfo.java | Interface | |
| LinkExtractorInfos.java | Interface | |
| Links.java | Interface | A collection of
Link s, typically retrieved from
Document.getLinks or
Version.getLinks . |
| LocaleHelper.java | Class | Helps converting between Locale objects and strings. |
| LocalizedException.java | Interface | |
| LockInfo.java | Interface | Provides information about a lock on a document variant. |
| LockType.java | enum | Enumeration of the available lock types. |
| Part.java | Interface | Parts belong to documents (or versions of documents), and are the things
that contain the actual data of the document.
A part is always associated with a
org.outerj.daisy.repository.schema.PartType .
The repository itself does not really place any restrictions
on the kind of data that can be contained in a part. |
| PartDataSource.java | Interface | |
| PartHelper.java | Class | |
| PartNotFoundException.java | Class | |
| PartPartDataSource.java | Class | A PartDataSource which gets its data from an existing part. |
| Parts.java | Interface | A collection of
Part objects. |
| Repository.java | Interface | Start point for a user to access the repository.
An instance of this object is obtained from the
RepositoryManager and
is contextualized for a certain user. |
| RepositoryEventType.java | Class | Enumeration of the possible repository events. |
| RepositoryException.java | Class | Thrown if something goes wrong in the repository. |
| RepositoryListener.java | Interface | Listener interface for repository related events.
The events are fired synchronously after their corresponding
operation has completed successfully. |
| RepositoryManager.java | Interface | A RepositoryManager is the place to get
Repository instances from. |
| RepositoryRuntimeException.java | Class | |
| ValueComparator.java | Class | A comparator which can be used sort the values of Daisy fields.
Includes support for hierarchical values. |
| ValueType.java | enum | Enumeration of the possible kinds of values that a field can have. |
| VariantKey.java | Class | An immutable object identifying a specific document variant. |
| VariantKeys.java | Class | |
| Version.java | Interface | A version of a
Document .
This object provides access to the all versioned information of a document,
for a specific version of the document. |
| VersionedData.java | Interface | Read-access to the versioned data of a Daisy document. |
| VersionKey.java | Class | An immutable object identifying a specific document variant and version. |
| VersionNotFoundException.java | Class | |
| Versions.java | Interface | A collection of
Version objects. |
| VersionState.java | enum | Enumeration of the states a
Version can be in. |