Public Member Functions | |
| Range (IdentifierRange identifierRange) | |
| long | getLength () |
| boolean | isLocked () |
| void | assignUniqueEntityId (EntityT entity) throws AcsJUidAlreadyExistsEx, AcsJRangeLockedEx, AcsJRangeExhaustedEx |
| void | replaceUniqueEntityId (EntityT entity) throws AcsJUidAlreadyExistsEx, AcsJRangeLockedEx, AcsJRangeExhaustedEx |
| void | assignUniqueEntityRef (EntityRefT ref) throws AcsJRangeUnlockedEx, AcsJRangeExhaustedEx |
| boolean | hasNextID () |
| URI | next () throws AcsJIdentifierUnexpectedEx, AcsJRangeExhaustedEx |
| URI | rangeId () throws AcsJIdentifierUnexpectedEx |
| final String | rangeIdString () |
Static Public Member Functions | |
| static final String | generateUID (String _archiveID, String _rangeID, long _localId) |
Package Functions | |
| long | getMaxDocumentId () |
This class represents a range of UIDs as created by the Alma archive, and allows using them as XML document IDs or links to XML documents. A range is always limited to a finite number of UIDs, given either by an explicitly requested limit, or otherwise by Long.MAX_VALUE many UIDs.
This class is implemented as an intelligent wrapper for the castor class IdentifierRange which itself gets generated from the schema "IdentifierRange.xsd".
For a better description, see the Archive/UidLibrary wiki page.
General remark on the length of UIDs: there is no limit on the length of the three "/x012af" parts of a UID, as was confirmed by awicenec to hsommer on 2007-04-20. It is therefore the Archive's responsibility to ensure that all code dealing with UIDs (which should all be under archive responsibility anyway) be updated accordingly whenever the actually generated UIDs exceed the "Long" limit.
| alma.acs.container.archive.Range.Range | ( | IdentifierRange | identifierRange | ) |
References alma.acs.container.archive.Range.isLocked().
| void alma.acs.container.archive.Range.assignUniqueEntityId | ( | EntityT | entity | ) | throws AcsJUidAlreadyExistsEx, AcsJRangeLockedEx, AcsJRangeExhaustedEx |
Assigns a UID to the EntityT castor object that should be a direct child of an Alma XML entity. As a means of protection, this call will fail if the entity already has a UID. If you actually need to replace a UID in some rare cases, please use replaceUniqueEntityId(EntityT).
The same functionality is offered in ContainerServices#assignUniqueEntityId(EntityT) which actually delegates to here.
Referenced by alma.acs.container.archive.UIDLibrary.assignUniqueEntityId().
| void alma.acs.container.archive.Range.assignUniqueEntityRef | ( | EntityRefT | ref | ) | throws AcsJRangeUnlockedEx, AcsJRangeExhaustedEx |
Assigns a UID from the range to a given entity reference. Note that this is different from assigning a UID to an entity. This method only works if this range is locked, see isLocked().
| ref |
References alma.acs.container.archive.Range.isLocked(), and alma.acs.container.archive.Range.rangeIdString().
Referenced by alma.acs.container.archive.UIDLibrary.assignUniqueEntityRef().
| static final String alma.acs.container.archive.Range.generateUID | ( | String | _archiveID, | |
| String | _rangeID, | |||
| long | _localId | |||
| ) | [static] |
This method is only exposed for testing purposes, when a UID has to be generated from its constituent parts. You should normally not use this method.
| long alma.acs.container.archive.Range.getLength | ( | ) |
| long alma.acs.container.archive.Range.getMaxDocumentId | ( | ) | [package] |
| boolean alma.acs.container.archive.Range.hasNextID | ( | ) |
Checks whether another UID can be pulled from this range without causing an exception due to an overflow.
Warning about thread safety: This method does not reserve a UID or anything like that, thus a returned true value does not necessarily mean that a later call to one of the assignXYZ etc methods will succeed.
Referenced by alma.acs.container.archive.UIDLibrary.checkDefaultRange().
| boolean alma.acs.container.archive.Range.isLocked | ( | ) |
A range can be either locked or unlocked. This immutable property was originally called "serialised" but was considered too confusing since this logical concept has nothing to do with technically serializing the castor class to XML.
TODO: explain better the real meaning of this locking, and the forseen scenarios.
Referenced by alma.acs.container.archive.Range.assignUniqueEntityRef(), and alma.acs.container.archive.Range.Range().
| URI alma.acs.container.archive.Range.next | ( | ) | throws AcsJIdentifierUnexpectedEx, AcsJRangeExhaustedEx |
cryptic comment from Simon: TODO: this needs to be moved to protected soon, will require the ArchiveID web service to be moved to this namespace
| AcsJIdentifierUnexpectedEx |
| URI alma.acs.container.archive.Range.rangeId | ( | ) | throws AcsJIdentifierUnexpectedEx |
Gets the UID of this range document itself.
| AcsJIdentifierUnexpectedEx | if the string from rangeIdString() cannot be turned into a URI |
References alma.acs.container.archive.Range.rangeIdString().
Referenced by alma.acs.container.archive.UIDLibrary.getNewRestrictedRange().
| final String alma.acs.container.archive.Range.rangeIdString | ( | ) |
Gets a String representation of the UID of this range document itself.
Referenced by alma.acs.container.archive.Range.assignUniqueEntityRef(), and alma.acs.container.archive.Range.rangeId().
| void alma.acs.container.archive.Range.replaceUniqueEntityId | ( | EntityT | entity | ) | throws AcsJUidAlreadyExistsEx, AcsJRangeLockedEx, AcsJRangeExhaustedEx |
Assigns a UID to the EntityT castor object that should be a direct child of an Alma XML entity. Unlike assignUniqueEntityID, this method will silently replace any existing UID, which is possibly dangerous. Therefore it should only be used in rare cases where replacing an existing ID is needed, for example when the ObsPrep tool might translate locally created documents into an archivable format.
Referenced by alma.acs.container.archive.UIDLibrary.replaceUniqueEntityId().
1.7.0
