Package org.dspace.content

Class ItemServiceImpl

java.lang.Object

org.dspace.content.DSpaceObjectServiceImpl<Item>

org.dspace.content.ItemServiceImpl

All Implemented Interfaces:

DSpaceObjectLegacySupportService<Item>, DSpaceObjectService<Item>, ItemService

public class ItemServiceImpl
extends DSpaceObjectServiceImpl<Item>
implements ItemService

Service implementation for the Item object. This class is responsible for all business logic calls for the Item object and is autowired by spring. This class should never be accessed directly.

Author:

kevinvandevelde at atmire.com

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthorizeService	authorizeService
protected BitstreamFormatService	bitstreamFormatService
protected BitstreamService	bitstreamService
protected BundleService	bundleService
protected CollectionService	collectionService
protected CommunityService	communityService
protected ConfigurationService	configurationService
protected DOIService	doiService
protected GroupService	groupService
protected HarvestedItemService	harvestedItemService
protected IdentifierService	identifierService
protected InstallItemService	installItemService
protected ItemDAO	itemDAO
protected MetadataSchemaService	metadataSchemaService
protected RelationshipService	relationshipService
protected ResourcePolicyService	resourcePolicyService
protected SearchService	searchService
protected SubscribeService	subscribeService
protected VersioningService	versioningService
protected VirtualMetadataPopulator	virtualMetadataPopulator
protected WorkflowItemService	workflowItemService
protected WorkspaceItemService	workspaceItemService

Fields inherited from class org.dspace.content.DSpaceObjectServiceImpl

choiceAuthorityService, handleService, metadataAuthorityService, metadataFieldService, metadataValueService

Fields inherited from interface org.dspace.content.service.DSpaceObjectService

MD_COPYRIGHT_TEXT, MD_INTRODUCTORY_TEXT, MD_LICENSE, MD_NAME, MD_PROVENANCE_DESCRIPTION, MD_SHORT_DESCRIPTION, MD_SIDEBAR_TEXT, MD_SOURCE, MD_USER_FORMAT_DESCRIPTION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ItemServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	addBundle(Context context, Item item, Bundle bundle)	Add an existing bundle to this item.
protected void	addDefaultPoliciesNotInPlace(Context context, DSpaceObject dso, List<ResourcePolicy> defaultCollectionPolicies)	Add the default policies, which have not been already added to the given DSpace object
MetadataValue	addMetadata(Context context, Item dso, String schema, String element, String qualifier, String lang, String value, String authority, int confidence, int place)	Add a single metadata value at the given place position.
void	adjustBitstreamPolicies(Context context, Item item, Collection collection, Bitstream bitstream)	Adjust the Bitstream policies to reflect what have been defined during the submission/workflow.
void	adjustBitstreamPolicies(Context context, Item item, Collection collection, Bitstream bitstream, boolean replaceReadRPWithCollectionRP)	Adjust the Bitstream policies to reflect what have been defined during the submission/workflow.
void	adjustBundleBitstreamPolicies(Context context, Item item, Collection collection)	Adjust the Bundle and Bitstream policies to reflect what have been defined during the submission/workflow.
void	adjustBundleBitstreamPolicies(Context context, Item item, Collection collection, boolean replaceReadRPWithCollectionRP)	Adjust the Bundle and Bitstream policies to reflect what have been defined during the submission/workflow.
void	adjustItemPolicies(Context context, Item item, Collection collection)	Adjust the Item's policies to reflect what have been defined during the submission/workflow.
void	adjustItemPolicies(Context context, Item item, Collection collection, boolean replaceReadRPWithCollectionRP)	Adjust the Item's policies to reflect what have been defined during the submission/workflow.
boolean	canCreateNewVersion(Context context, Item item)	return TRUE if context's user can create new version of the item, false otherwise.
boolean	canEdit(Context context, Item item)	return TRUE if context's user can edit item, false otherwise
int	countAllItems(Context context, Collection collection)	counts all items in the given collection including withdrawn items
int	countAllItems(Context context, Community community)	counts all items in the given community including withdrawn
int	countArchivedItems(Context context)	counts all items in archive
int	countByCollectionMapping(Context context, Collection collection)	Count all the archived items mapped to this collection (excludes owning collection).
long	countForMetadataQuery(Context context, List<QueryPredicate> queryPredicates, List<UUID> collectionUuids)	Returns the total number of items that match the given predicates, within the specified collections, if any.
int	countItems(Context context, Collection collection)	counts items in the given collection
int	countItems(Context context, Community community)	counts items in the given community
int	countItemsWithEdit(Context context)	counts all items for which the current user has editing rights
int	countNotArchivedItems(Context context)	counts all items not in archive
int	countTotal(Context context)	counts all items
int	countWithdrawnItems(Context context)	counts all withdrawn items
Item	create(Context context, WorkspaceItem workspaceItem)	Create a new item, with a new internal ID.
Item	create(Context context, WorkspaceItem workspaceItem, UUID uuid)	Create a new item, with a provided ID.
protected Item	createItem(Context context)
protected Item	createItem(Context context, UUID uuid)
Bitstream	createSingleBitstream(Context context, InputStream is, Item item)	Convenience method, calls createSingleBitstream() with name "ORIGINAL"
Bitstream	createSingleBitstream(Context context, InputStream is, Item item, String name)	Create a single bitstream in a new bundle.
Item	createTemplateItem(Context context, Collection collection)	Create an empty template item for this collection.
void	delete(Context context, Item item)
protected void	deleteBundle(Context context, Item item, Bundle b)
Item	find(Context context, UUID id)	Generic find for when the precise type of an Entity is not known
Iterator<Item>	findAll(Context context)	Get all the items in the archive.
Iterator<Item>	findAll(Context context, Integer limit, Integer offset)	Get all the items in the archive.
Iterator<Item>	findAllByCollection(Context context, Collection collection)	Get all the items (including private and withdrawn) in this collection.
Iterator<Item>	findAllByCollection(Context context, Collection collection, Integer limit, Integer offset)	Get all the items (including private and withdrawn) in this collection.
Iterator<Item>	findAllRegularItems(Context context)	Find all items that are: - NOT in the workspace - NOT in the workflow - NOT a template item for e.g. a collection This implies that the result also contains older versions of items and withdrawn items.
Iterator<Item>	findAllUnfiltered(Context context)	Get all "final" items in the archive, both archived ("in archive" flag) or withdrawn items are included.
Iterator<Item>	findArchivedByMetadataField(Context context, String metadataField, String value)	Returns an iterator of in archive items possessing the passed metadata field, or only those matching the passed value, if value is not Item.ANY
Iterator<Item>	findArchivedByMetadataField(Context context, String schema, String element, String qualifier, String value)	Returns an iterator of Items possessing the passed metadata field, or only those matching the passed value, if value is not Item.ANY
Iterator<Item>	findByAuthorityValue(Context context, String schema, String element, String qualifier, String value)	Find all the items in the archive with a given authority key value in the indicated metadata field.
Iterator<Item>	findByCollection(Context context, Collection collection)	Get all the archived items in this collection.
Iterator<Item>	findByCollection(Context context, Collection collection, Integer limit, Integer offset)	Get all the archived items in this collection.
Iterator<Item>	findByCollectionMapping(Context context, Collection collection, Integer limit, Integer offset)	Get all the archived items mapped to this collection (excludes owning collection).
Item	findByIdOrLegacyId(Context context, String id)
Iterator<Item>	findByLastModifiedSince(Context context, Instant last)	Find all Items modified since a Date.
Item	findByLegacyId(Context context, int id)	Generic find for when the precise type of a DSO is not known, just the a pair of type number and database ID.
Iterator<Item>	findByMetadataField(Context context, String schema, String element, String qualifier, String value)	Returns an iterator of Items possessing the passed metadata field, or only those matching the passed value, if value is not Item.ANY
Iterator<Item>	findByMetadataFieldAuthority(Context context, String mdString, String authority)
List<Item>	findByMetadataQuery(Context context, List<QueryPredicate> queryPredicates, List<UUID> collectionUuids, long offset, int limit)	Returns a list of items that match the given predicates, within the specified collections, if any.
Iterator<Item>	findBySubmitter(Context context, EPerson eperson)	Find all the items in the archive by a given submitter.
Iterator<Item>	findBySubmitter(Context context, EPerson eperson, boolean retrieveAllItems)	Find all the items by a given submitter.
Iterator<Item>	findBySubmitterDateSorted(Context context, EPerson eperson, Integer limit)	Retrieve the list of items submitted by eperson, ordered by recently submitted, optionally limitable
Iterator<Item>	findInArchiveOrWithdrawnDiscoverableModifiedSince(Context context, Instant since)	Get all Items installed or withdrawn, discoverable, and modified since a Date.
Iterator<Item>	findInArchiveOrWithdrawnNonDiscoverableModifiedSince(Context context, Instant since)	Get all Items installed or withdrawn, NON-discoverable, and modified since a Date.
List<Item>	findItemsWithEdit(Context context, int offset, int limit)	finds all items for which the current user has editing rights
DSpaceObject	getAdminObject(Context context, Item item, int action)	Return the dspace object where an ADMIN action right is sufficient to grant the initial authorize check.
protected void	getAuthoritiesAndConfidences(String fieldKey, Collection collection, List<String> values, List<String> authorities, List<Integer> confidences, int i)
List<Bundle>	getBundles(Item item, String name)	Get the bundles matching a bundle name (name corresponds roughly to type)
List<Collection>	getCollectionsNotLinked(Context context, Item item)	Get the collections this item is not in.
List<Community>	getCommunities(Context context, Item item)	Get the communities this item is in.
EntityType	getEntityType(Context context, Item item)	Retrieve the entity type of the given item.
String	getEntityTypeLabel(Item item)	Retrieve the label of the entity type of the given item.
List<MetadataValue>	getMetadata(Item item, String schema, String element, String qualifier, String lang)	This method will return a list of MetadataValue objects that contains all the regular metadata of the item passed along in the parameters as well as all the virtual metadata which will be generated and processed together with the VirtualMetadataPopulator by processing the item's relationships
List<MetadataValue>	getMetadata(Item item, String schema, String element, String qualifier, String lang, boolean enableVirtualMetadata)	Get metadata for the DSpace Object in a chosen schema.
List<Bitstream>	getNonInternalBitstreams(Context context, Item item)	Get all non-internal bitstreams in the item.
DSpaceObject	getParentObject(Context context, Item item)	Return the dspace object that "own" the current object in the hierarchy.
int	getSupportsTypeConstant()	Returns the Constants which this service supports
Thumbnail	getThumbnail(Context context, Item item, boolean requireOriginal)
boolean	hasUploadedFiles(Item item)	Check the bundle ORIGINAL to see if there are any uploaded files
void	inheritCollectionDefaultPolicies(Context context, Item item, Collection collection)	Remove all policies on an item and its contents, and replace them with the DEFAULT_ITEM_READ and DEFAULT_BITSTREAM_READ policies belonging to the collection.
void	inheritCollectionDefaultPolicies(Context context, Item item, Collection collection, boolean replaceReadRPWithCollectionRP)	Remove all submission and workflow policies on an item and its contents, and add default collection policies which are not yet already in place.
boolean	isIn(Item item, Collection collection)	See whether this Item is contained by a given Collection.
boolean	isInProgressSubmission(Context context, Item item)	Check if the item is an inprogress submission
boolean	isItemListedForUser(Context context, Item item)	Service method for knowing if this Item should be visible in the item list.
boolean	isLatestVersion(Context context, Item item)	Check whether the given item is the latest version.
boolean	isOwningCollection(Item item, Collection collection)	Return true if this Collection 'owns' this item
void	move(Context context, Item item, Collection from, Collection to)	Moves the item from one collection to another one
void	move(Context context, Item item, Collection from, Collection to, boolean inheritDefaultPolicies)	Moves the item from one collection to another one
protected void	moveSingleMetadataValue(Context context, Item dso, int place, MetadataValue rr)	Supports moving metadata by adding the metadata value or updating the place of the relationship
void	populateWithTemplateItemMetadata(Context context, Collection collection, boolean template, Item item)	Populate the given item with all template item specified metadata.
protected void	rawDelete(Context context, Item item)
void	reinstate(Context context, Item item)	Reinstate a withdrawn item
void	removeAllBundles(Context context, Item item)	Remove all bundles linked to this item.
void	removeBundle(Context context, Item item, Bundle bundle)	Remove a bundle.
void	removeDSpaceLicense(Context context, Item item)	Remove just the DSpace license from an item This is useful to update the current DSpace license, in case the user must accept the DSpace license again (either the item was rejected, or resumed after saving)
void	removeGroupPolicies(Context context, Item item, Group group)	remove all of the policies for item's bitstreams and bundles that belong to a given Group
void	removeLicenses(Context context, Item item)	Remove all licenses from an item - it was rejected
protected void	removeRequest(Context context, Item item)
protected void	removeVersion(Context context, Item item)
void	replaceAllBitstreamPolicies(Context context, Item item, List<ResourcePolicy> newpolicies)	remove all of the policies for item's bitstreams and bundles and replace them with a new list of policies
void	replaceAllItemPolicies(Context context, Item item, List<ResourcePolicy> newpolicies)	remove all of the policies for item and replace them with a new list of policies
void	update(Context context, Item item)
void	updateLastModified(Context context, Item item)
void	withdraw(Context context, Item item)	Withdraw the item from the archive.

Methods inherited from class org.dspace.content.DSpaceObjectServiceImpl

addAndShiftRightMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, clearMetadata, getElements, getElementsFilled, getIdentifiers, getMDValueByField, getMDValueByLegacyField, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataFirstValue, getMetadataFirstValue, getMetadataValuePlace, getName, getTypeText, match, moveMetadata, removeMetadataValues, replaceMetadata, setMetadataModified, setMetadataSingleValue, setMetadataSingleValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dspace.content.service.DSpaceObjectService

addAndShiftRightMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, addMetadata, clearMetadata, getIdentifiers, getMetadata, getMetadata, getMetadata, getMetadataByMetadataString, getMetadataFirstValue, getMetadataFirstValue, getName, getTypeText, moveMetadata, removeMetadataValues, replaceMetadata, setMetadataModified, setMetadataSingleValue, setMetadataSingleValue

Field Details

itemDAO

@Autowired(required=true)
protected ItemDAO itemDAO

communityService

@Autowired(required=true)
protected CommunityService communityService

groupService

@Autowired(required=true)
protected GroupService groupService

authorizeService

@Autowired(required=true)
protected AuthorizeService authorizeService

bundleService

@Autowired(required=true)
protected BundleService bundleService

bitstreamFormatService

@Autowired(required=true)
protected BitstreamFormatService bitstreamFormatService

metadataSchemaService

@Autowired(required=true)
protected MetadataSchemaService metadataSchemaService

bitstreamService

@Autowired(required=true)
protected BitstreamService bitstreamService

installItemService

@Autowired(required=true)
protected InstallItemService installItemService

searchService

@Autowired(required=true)
protected SearchService searchService

resourcePolicyService

@Autowired(required=true)
protected ResourcePolicyService resourcePolicyService

collectionService

@Autowired(required=true)
protected CollectionService collectionService

identifierService

@Autowired(required=true)
protected IdentifierService identifierService

doiService

@Autowired(required=true)
protected DOIService doiService

versioningService

@Autowired(required=true)
protected VersioningService versioningService

harvestedItemService

@Autowired(required=true)
protected HarvestedItemService harvestedItemService

configurationService

@Autowired(required=true)
protected ConfigurationService configurationService

workspaceItemService

@Autowired(required=true)
protected WorkspaceItemService workspaceItemService

workflowItemService

@Autowired(required=true)
protected WorkflowItemService workflowItemService

relationshipService

@Autowired(required=true)
protected RelationshipService relationshipService

virtualMetadataPopulator

@Autowired(required=true)
protected VirtualMetadataPopulator virtualMetadataPopulator

subscribeService

@Autowired(required=true)
protected SubscribeService subscribeService

Constructor Details

ItemServiceImpl

protected ItemServiceImpl()

Method Details

getThumbnail

public Thumbnail getThumbnail(Context context,
 Item item,
 boolean requireOriginal)
                       throws SQLException

Specified by:

getThumbnail in interface ItemService

Throws:

SQLException

find

public Item find(Context context,
 UUID id)
          throws SQLException

Description copied from interface: DSpaceObjectService

Generic find for when the precise type of an Entity is not known

Specified by:

find in interface DSpaceObjectService<Item>

Parameters:

context - - the context

id - - uuid within table of typed dspace objects

Returns:

the dspace object found, or null if it does not exist.

Throws:

SQLException - only upon failure accessing the database.

create

public Item create(Context context,
 WorkspaceItem workspaceItem)
            throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Create a new item, with a new internal ID. Authorization is done inside of this method.

Specified by:

create in interface ItemService

Parameters:

context - DSpace context object

workspaceItem - in progress workspace item

Returns:

the newly created item

Throws:

SQLException - if database error

AuthorizeException - if authorization error

create

public Item create(Context context,
 WorkspaceItem workspaceItem,
 UUID uuid)
            throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Create a new item, with a provided ID. Authorisation is done inside of this method.

Specified by:

create in interface ItemService

Parameters:

context - DSpace context object

workspaceItem - in progress workspace item

uuid - the pre-determined UUID to assign to the new item

Returns:

the newly created item

Throws:

SQLException - if database error

AuthorizeException - if authorization error

createTemplateItem

public Item createTemplateItem(Context context,
 Collection collection)
                        throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Create an empty template item for this collection. If one already exists, no action is taken. Caution: Make sure you call update on the collection after doing this, or the item will have been created but the collection record will not refer to it.

Specified by:

createTemplateItem in interface ItemService

Parameters:

context - DSpace context object

collection - Collection (parent)

Returns:

empty template item for this collection

Throws:

SQLException - if database error

AuthorizeException - if authorization error

populateWithTemplateItemMetadata

public void populateWithTemplateItemMetadata(Context context,
 Collection collection,
 boolean template,
 Item item)
                                      throws SQLException

Description copied from interface: ItemService

Populate the given item with all template item specified metadata.

Specified by:

populateWithTemplateItemMetadata in interface ItemService

Parameters:

context - DSpace context object

collection - Collection (parent)

template - if true, the item inherits all collection's template item metadata

item - item to populate with template item specified metadata

Throws:

SQLException - if database error

findAll

public Iterator<Item> findAll(Context context)
                       throws SQLException

Description copied from interface: ItemService

Get all the items in the archive. Only items with the "in archive" flag set are included. The order of the list is indeterminate.

Specified by:

findAll in interface ItemService

Parameters:

context - DSpace context object

Returns:

an iterator over the items in the archive.

Throws:

SQLException - if database error

findAll

public Iterator<Item> findAll(Context context,
 Integer limit,
 Integer offset)
                       throws SQLException

Description copied from interface: ItemService

Get all the items in the archive. Only items with the "in archive" flag set are included. The order of the list is indeterminate.

Specified by:

findAll in interface ItemService

Parameters:

context - DSpace context object

limit - limit

offset - offset

Returns:

an iterator over the items in the archive.

Throws:

SQLException - if database error

findAllUnfiltered

public Iterator<Item> findAllUnfiltered(Context context)
                                 throws SQLException

Description copied from interface: ItemService

Get all "final" items in the archive, both archived ("in archive" flag) or withdrawn items are included. The order of the list is indeterminate.

Specified by:

findAllUnfiltered in interface ItemService

Parameters:

context - DSpace context object

Returns:

an iterator over the items in the archive.

Throws:

SQLException - if database error

findAllRegularItems

public Iterator<Item> findAllRegularItems(Context context)
                                   throws SQLException

Description copied from interface: ItemService

Find all items that are: - NOT in the workspace - NOT in the workflow - NOT a template item for e.g. a collection This implies that the result also contains older versions of items and withdrawn items.

Specified by:

findAllRegularItems in interface ItemService

Parameters:

context - the DSpace context.

Returns:

iterator over all regular items.

Throws:

SQLException - if database error.

findBySubmitter

public Iterator<Item> findBySubmitter(Context context,
 EPerson eperson)
                               throws SQLException

Description copied from interface: ItemService

Find all the items in the archive by a given submitter. The order is indeterminate. Only items with the "in archive" flag set are included.

Specified by:

findBySubmitter in interface ItemService

Parameters:

context - DSpace context object

eperson - the submitter

Returns:

an iterator over the items submitted by eperson

Throws:

SQLException - if database error

findBySubmitter

public Iterator<Item> findBySubmitter(Context context,
 EPerson eperson,
 boolean retrieveAllItems)
                               throws SQLException

Description copied from interface: ItemService

Find all the items by a given submitter. The order is indeterminate. All items are included.

Specified by:

findBySubmitter in interface ItemService

Parameters:

context - DSpace context object

eperson - the submitter

retrieveAllItems - flag to determine if all items should be returned or only archived items. If true, all items (regardless of status) are returned. If false, only archived items will be returned.

Returns:

an iterator over the items submitted by eperson

Throws:

SQLException - if database error

findBySubmitterDateSorted

public Iterator<Item> findBySubmitterDateSorted(Context context,
 EPerson eperson,
 Integer limit)
                                         throws SQLException

Description copied from interface: ItemService

Retrieve the list of items submitted by eperson, ordered by recently submitted, optionally limitable

Specified by:

findBySubmitterDateSorted in interface ItemService

Parameters:

context - DSpace context object

eperson - the submitter

limit - a positive integer to limit, -1 or null for unlimited

Returns:

an iterator over the items submitted by eperson

Throws:

SQLException - if database error

findByCollection

public Iterator<Item> findByCollection(Context context,
 Collection collection)
                                throws SQLException

Description copied from interface: ItemService

Get all the archived items in this collection. The order is indeterminate.

Specified by:

findByCollection in interface ItemService

Parameters:

context - DSpace context object

collection - Collection (parent)

Returns:

an iterator over the items in the collection.

Throws:

SQLException - if database error

findByCollection

public Iterator<Item> findByCollection(Context context,
 Collection collection,
 Integer limit,
 Integer offset)
                                throws SQLException

Description copied from interface: ItemService

Get all the archived items in this collection. The order is indeterminate.

Specified by:

findByCollection in interface ItemService

Parameters:

context - DSpace context object

collection - Collection (parent)

limit - limited number of items

offset - offset value

Returns:

an iterator over the items in the collection.

Throws:

SQLException - if database error

findByCollectionMapping

public Iterator<Item> findByCollectionMapping(Context context,
 Collection collection,
 Integer limit,
 Integer offset)
                                       throws SQLException

Description copied from interface: ItemService

Get all the archived items mapped to this collection (excludes owning collection). The order is indeterminate.

Specified by:

findByCollectionMapping in interface ItemService

Parameters:

context - DSpace context object

collection - Collection (parent)

limit - limited number of items

offset - offset value

Returns:

an iterator over the items in the collection.

Throws:

SQLException - if database error

countByCollectionMapping

public int countByCollectionMapping(Context context,
 Collection collection)
                             throws SQLException

Description copied from interface: ItemService

Count all the archived items mapped to this collection (excludes owning collection). The order is indeterminate.

Specified by:

countByCollectionMapping in interface ItemService

Parameters:

context - DSpace context object

collection - Collection (parent)

Returns:

an iterator over the items in the collection.

Throws:

SQLException - if database error

findAllByCollection

public Iterator<Item> findAllByCollection(Context context,
 Collection collection)
                                   throws SQLException

Description copied from interface: ItemService

Get all the items (including private and withdrawn) in this collection. The order is indeterminate.

Specified by:

findAllByCollection in interface ItemService

Parameters:

context - DSpace context object

collection - Collection (parent)

Returns:

an iterator over the items in the collection.

Throws:

SQLException - if database error

findAllByCollection

public Iterator<Item> findAllByCollection(Context context,
 Collection collection,
 Integer limit,
 Integer offset)
                                   throws SQLException

Description copied from interface: ItemService

Get all the items (including private and withdrawn) in this collection. The order is indeterminate.

Specified by:

findAllByCollection in interface ItemService

Parameters:

context - DSpace context object

collection - Collection (parent)

limit - limited number of items

offset - offset value

Returns:

an iterator over the items in the collection.

Throws:

SQLException - if database error

findInArchiveOrWithdrawnDiscoverableModifiedSince

public Iterator<Item> findInArchiveOrWithdrawnDiscoverableModifiedSince(Context context,
 Instant since)
                                                                 throws SQLException

Description copied from interface: ItemService

Get all Items installed or withdrawn, discoverable, and modified since a Date.

Specified by:

findInArchiveOrWithdrawnDiscoverableModifiedSince in interface ItemService

Parameters:

context - DSpace context object

since - earliest interesting last-modified date, or null for no date test.

Returns:

an iterator over the items in the collection.

Throws:

SQLException - if database error

findInArchiveOrWithdrawnNonDiscoverableModifiedSince

public Iterator<Item> findInArchiveOrWithdrawnNonDiscoverableModifiedSince(Context context,
 Instant since)
                                                                    throws SQLException

Description copied from interface: ItemService

Get all Items installed or withdrawn, NON-discoverable, and modified since a Date.

Specified by:

findInArchiveOrWithdrawnNonDiscoverableModifiedSince in interface ItemService

Parameters:

context - context

since - earliest interesting last-modified date, or null for no date test.

Returns:

an iterator over the items in the collection.

Throws:

SQLException - if database error

updateLastModified

public void updateLastModified(Context context,
 Item item)
                        throws SQLException,
AuthorizeException

Specified by:

updateLastModified in interface DSpaceObjectService<Item>

Throws:

SQLException

AuthorizeException

isIn

public boolean isIn(Item item,
 Collection collection)
             throws SQLException

Description copied from interface: ItemService

See whether this Item is contained by a given Collection.

Specified by:

isIn in interface ItemService

Parameters:

item - item to check

collection - Collection (parent

Returns:

true if collection contains this Item.

Throws:

SQLException - if database error

getCommunities

public List<Community> getCommunities(Context context,
 Item item)
                               throws SQLException

Description copied from interface: ItemService

Get the communities this item is in. Returns an unordered array of the communities that house the collections this item is in, including parent communities of the owning collections.

Specified by:

getCommunities in interface ItemService

Parameters:

context - DSpace context object

item - item to check

Returns:

the communities this item is in.

Throws:

SQLException - if database error

getBundles

public List<Bundle> getBundles(Item item,
 String name)
                        throws SQLException

Description copied from interface: ItemService

Get the bundles matching a bundle name (name corresponds roughly to type)

Specified by:

getBundles in interface ItemService

Parameters:

item - item to check

name - name of bundle (ORIGINAL/TEXT/THUMBNAIL)

Returns:

the bundles in an unordered array

Throws:

SQLException - if database error

addBundle

public void addBundle(Context context,
 Item item,
 Bundle bundle)
               throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Add an existing bundle to this item. This has immediate effect.

Specified by:

addBundle in interface ItemService

Parameters:

context - DSpace context object

item - item to add the bundle to

bundle - the bundle to add

Throws:

SQLException - if database error

AuthorizeException - if authorization error

removeBundle

public void removeBundle(Context context,
 Item item,
 Bundle bundle)
                  throws SQLException,
AuthorizeException,
IOException

Description copied from interface: ItemService

Remove a bundle. This may result in the bundle being deleted, if the bundle is orphaned.

Specified by:

removeBundle in interface ItemService

Parameters:

context - DSpace context object

item - Item

bundle - the bundle to remove

Throws:

SQLException - if database error

AuthorizeException - if authorization error

IOException - if IO error

createSingleBitstream

public Bitstream createSingleBitstream(Context context,
 InputStream is,
 Item item,
 String name)
                                throws AuthorizeException,
IOException,
SQLException

Description copied from interface: ItemService

Create a single bitstream in a new bundle. Provided as a convenience method for the most common use.

Specified by:

createSingleBitstream in interface ItemService

Parameters:

context - DSpace context object

is - the stream to create the new bitstream from

item - item to create bitstream on

name - is the name of the bundle (ORIGINAL, TEXT, THUMBNAIL)

Returns:

Bitstream that is created

Throws:

AuthorizeException - if authorization error

IOException - if IO error

SQLException - if database error

createSingleBitstream

public Bitstream createSingleBitstream(Context context,
 InputStream is,
 Item item)
                                throws AuthorizeException,
IOException,
SQLException

Description copied from interface: ItemService

Convenience method, calls createSingleBitstream() with name "ORIGINAL"

Specified by:

createSingleBitstream in interface ItemService

Parameters:

context - DSpace context object

is - InputStream

item - item to create bitstream on

Returns:

created bitstream

Throws:

AuthorizeException - if authorization error

IOException - if IO error

SQLException - if database error

getNonInternalBitstreams

public List<Bitstream> getNonInternalBitstreams(Context context,
 Item item)
                                         throws SQLException

Description copied from interface: ItemService

Get all non-internal bitstreams in the item. This is mainly used for auditing for provenance messages and adding format.* DC values. The order is indeterminate.

Specified by:

getNonInternalBitstreams in interface ItemService

Parameters:

context - DSpace context object

item - item to check

Returns:

non-internal bitstreams.

Throws:

SQLException - if database error

createItem

protected Item createItem(Context context,
 UUID uuid)
                   throws SQLException,
AuthorizeException

Throws:

SQLException

AuthorizeException

createItem

protected Item createItem(Context context)
                   throws SQLException,
AuthorizeException

Throws:

SQLException

AuthorizeException

removeDSpaceLicense

public void removeDSpaceLicense(Context context,
 Item item)
                         throws SQLException,
AuthorizeException,
IOException

Description copied from interface: ItemService

Remove just the DSpace license from an item This is useful to update the current DSpace license, in case the user must accept the DSpace license again (either the item was rejected, or resumed after saving)

This method is used by the org.dspace.submit.step.LicenseStep class

Specified by:

removeDSpaceLicense in interface ItemService

Parameters:

context - DSpace context object

item - item to remove DSpace license from

Throws:

SQLException - if database error

AuthorizeException - if authorization error

IOException - if IO error

removeLicenses

public void removeLicenses(Context context,
 Item item)
                    throws SQLException,
AuthorizeException,
IOException

Description copied from interface: ItemService

Remove all licenses from an item - it was rejected

Specified by:

removeLicenses in interface ItemService

Parameters:

context - DSpace context object

item - item to remove all licenses from

Throws:

SQLException - if database error

AuthorizeException - if authorization error

IOException - if IO error

update

public void update(Context context,
 Item item)
            throws SQLException,
AuthorizeException

Specified by:

update in interface DSpaceObjectService<Item>

Overrides:

update in class DSpaceObjectServiceImpl<Item>

Throws:

SQLException

AuthorizeException

withdraw

public void withdraw(Context context,
 Item item)
              throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Withdraw the item from the archive. It is kept in place, and the content and metadata are not deleted, but it is not publicly accessible.

Specified by:

withdraw in interface ItemService

Parameters:

context - DSpace context object

item - item to withdraw

Throws:

SQLException - if database error

AuthorizeException - if authorization error

reinstate

public void reinstate(Context context,
 Item item)
               throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Reinstate a withdrawn item

Specified by:

reinstate in interface ItemService

Parameters:

context - DSpace context object

item - withdrawn item to reinstate

Throws:

SQLException - if database error

AuthorizeException - if authorization error

delete

public void delete(Context context,
 Item item)
            throws SQLException,
AuthorizeException,
IOException

Specified by:

delete in interface DSpaceObjectService<Item>

Throws:

SQLException

AuthorizeException

IOException

getSupportsTypeConstant

public int getSupportsTypeConstant()

Description copied from interface: DSpaceObjectService

Returns the Constants which this service supports

Specified by:

getSupportsTypeConstant in interface DSpaceObjectLegacySupportService<Item>

Specified by:

getSupportsTypeConstant in interface DSpaceObjectService<Item>

Returns:

a org.dspace.core.Constants that represents a IndexableObject type

rawDelete

protected void rawDelete(Context context,
 Item item)
                  throws AuthorizeException,
SQLException,
IOException

Throws:

AuthorizeException

SQLException

IOException

removeRequest

protected void removeRequest(Context context,
 Item item)
                      throws SQLException

Throws:

SQLException

removeAllBundles

public void removeAllBundles(Context context,
 Item item)
                      throws AuthorizeException,
SQLException,
IOException

Description copied from interface: ItemService

Remove all bundles linked to this item. This may result in the bundle being deleted, if the bundle is orphaned.

Specified by:

removeAllBundles in interface ItemService

Parameters:

context - DSpace context object

item - the item from which to remove all bundles

Throws:

AuthorizeException - if authorization error

SQLException - if database error

IOException - if IO error

deleteBundle

protected void deleteBundle(Context context,
 Item item,
 Bundle b)
                     throws AuthorizeException,
SQLException,
IOException

Throws:

AuthorizeException

SQLException

IOException

removeVersion

protected void removeVersion(Context context,
 Item item)
                      throws AuthorizeException,
SQLException

Throws:

AuthorizeException

SQLException

isOwningCollection

public boolean isOwningCollection(Item item,
 Collection collection)

Description copied from interface: ItemService

Return true if this Collection 'owns' this item

Specified by:

isOwningCollection in interface ItemService

Parameters:

item - item to check

collection - Collection

Returns:

true if this Collection owns this item

replaceAllItemPolicies

public void replaceAllItemPolicies(Context context,
 Item item,
 List<ResourcePolicy> newpolicies)
                            throws SQLException,
AuthorizeException

Description copied from interface: ItemService

remove all of the policies for item and replace them with a new list of policies

Specified by:

replaceAllItemPolicies in interface ItemService

Parameters:

context - DSpace context object

item - item to replace policies on

newpolicies - - this will be all of the new policies for the item and its contents

Throws:

SQLException - if database error

AuthorizeException - if authorization error

replaceAllBitstreamPolicies

public void replaceAllBitstreamPolicies(Context context,
 Item item,
 List<ResourcePolicy> newpolicies)
                                 throws SQLException,
AuthorizeException

Description copied from interface: ItemService

remove all of the policies for item's bitstreams and bundles and replace them with a new list of policies

Specified by:

replaceAllBitstreamPolicies in interface ItemService

Parameters:

context - DSpace context object

item - item to replace policies on

newpolicies - - this will be all of the new policies for the bundle and bitstream contents

Throws:

SQLException - if database error

AuthorizeException - if authorization error

removeGroupPolicies

public void removeGroupPolicies(Context context,
 Item item,
 Group group)
                         throws SQLException,
AuthorizeException

Description copied from interface: ItemService

remove all of the policies for item's bitstreams and bundles that belong to a given Group

Specified by:

removeGroupPolicies in interface ItemService

Parameters:

context - DSpace context object

item - item to remove group policies from

group - Group referenced by policies that needs to be removed

Throws:

SQLException - if database error

AuthorizeException - if authorization error

inheritCollectionDefaultPolicies

public void inheritCollectionDefaultPolicies(Context context,
 Item item,
 Collection collection)
                                      throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Remove all policies on an item and its contents, and replace them with the DEFAULT_ITEM_READ and DEFAULT_BITSTREAM_READ policies belonging to the collection.

Specified by:

inheritCollectionDefaultPolicies in interface ItemService

Parameters:

context - DSpace context object

item - item to reset policies on

collection - Collection

Throws:

SQLException - if database error if an SQL error or if no default policies found. It's a bit draconian, but default policies must be enforced.

AuthorizeException - if authorization error

inheritCollectionDefaultPolicies

public void inheritCollectionDefaultPolicies(Context context,
 Item item,
 Collection collection,
 boolean replaceReadRPWithCollectionRP)
                                      throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Remove all submission and workflow policies on an item and its contents, and add default collection policies which are not yet already in place. If overrideItemReadPolicies is true, then all read policies on the item are replaced (but only if the collection has a default read policy).

Specified by:

inheritCollectionDefaultPolicies in interface ItemService

Parameters:

context - DSpace context object

item - item to reset policies on

collection - Collection

replaceReadRPWithCollectionRP - if true, all read policies on the item are replaced (but only if the collection has a default read policy)

Throws:

SQLException - if database error if an SQL error or if no default policies found. It's a bit draconian, but default policies must be enforced.

AuthorizeException - if authorization error

adjustBundleBitstreamPolicies

public void adjustBundleBitstreamPolicies(Context context,
 Item item,
 Collection collection)
                                   throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Adjust the Bundle and Bitstream policies to reflect what have been defined during the submission/workflow. The temporary SUBMISSION and WORKFLOW policies are removed and the policies defined at the item and collection level are copied and inherited as appropriate. Custom selected Item policies are copied to the bundle/bitstream only if no explicit custom policies were already applied to the bundle/bitstream. Collection's policies are inherited if there are no other policies defined or if the append mode is defined by the configuration via the core.authorization.installitem.inheritance-read.append-mode property

Specified by:

adjustBundleBitstreamPolicies in interface ItemService

Parameters:

context - DSpace context object

item - Item to adjust policies on

collection - Collection

Throws:

SQLException - If database error

AuthorizeException - If authorization error

adjustBundleBitstreamPolicies

public void adjustBundleBitstreamPolicies(Context context,
 Item item,
 Collection collection,
 boolean replaceReadRPWithCollectionRP)
                                   throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Adjust the Bundle and Bitstream policies to reflect what have been defined during the submission/workflow. The temporary SUBMISSION and WORKFLOW policies are removed and the policies defined at the item and collection level are copied and inherited as appropriate. Custom selected Item policies are copied to the bundle/bitstream only if no explicit custom policies were already applied to the bundle/bitstream. Collection's policies are inherited if there are no other policies defined or if the append mode is defined by the configuration via the core.authorization.installitem.inheritance-read.append-mode property

Specified by:

adjustBundleBitstreamPolicies in interface ItemService

Parameters:

context - DSpace context object

item - Item to adjust policies on

collection - Collection

replaceReadRPWithCollectionRP - if true, all read policies on the item are replaced (but only if the collection has a default read policy)

Throws:

SQLException - If database error

AuthorizeException - If authorization error

adjustBitstreamPolicies

public void adjustBitstreamPolicies(Context context,
 Item item,
 Collection collection,
 Bitstream bitstream)
                             throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Adjust the Bitstream policies to reflect what have been defined during the submission/workflow. The temporary SUBMISSION and WORKFLOW policies are removed and the policies defined at the item and collection level are copied and inherited as appropriate. Custom selected Item policies are copied to the bitstream only if no explicit custom policies were already applied to the bitstream. Collection's policies are inherited if there are no other policies defined or if the append mode is defined by the configuration via the core.authorization.installitem.inheritance-read.append-mode property

Specified by:

adjustBitstreamPolicies in interface ItemService

Parameters:

context - DSpace context object

item - Item to adjust policies on

collection - Collection

bitstream - Bitstream to adjust policies on

Throws:

SQLException - If database error

AuthorizeException - If authorization error

adjustBitstreamPolicies

public void adjustBitstreamPolicies(Context context,
 Item item,
 Collection collection,
 Bitstream bitstream,
 boolean replaceReadRPWithCollectionRP)
                             throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Adjust the Bitstream policies to reflect what have been defined during the submission/workflow. The temporary SUBMISSION and WORKFLOW policies are removed and the policies defined at the item and collection level are copied and inherited as appropriate. Custom selected Item policies are copied to the bitstream only if no explicit custom policies were already applied to the bitstream. Collection's policies are inherited if there are no other policies defined or if the append mode is defined by the configuration via the core.authorization.installitem.inheritance-read.append-mode property

Specified by:

adjustBitstreamPolicies in interface ItemService

Parameters:

context - DSpace context object

item - Item to adjust policies on

collection - Collection

bitstream - Bitstream to adjust policies on

replaceReadRPWithCollectionRP - If true, all read policies on the bitstream are replaced (but only if the collection has a default read policy)

Throws:

SQLException - If database error

AuthorizeException - If authorization error

adjustItemPolicies

public void adjustItemPolicies(Context context,
 Item item,
 Collection collection)
                        throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Adjust the Item's policies to reflect what have been defined during the submission/workflow. The temporary SUBMISSION and WORKFLOW policies are removed and the default policies defined at the collection level are inherited as appropriate. Collection's policies are inherited if there are no other policies defined or if the append mode is defined by the configuration via the core.authorization.installitem.inheritance-read.append-mode property

Specified by:

adjustItemPolicies in interface ItemService

Parameters:

context - DSpace context object

item - Item to adjust policies on

collection - Collection

Throws:

SQLException - If database error

AuthorizeException - If authorization error

adjustItemPolicies

public void adjustItemPolicies(Context context,
 Item item,
 Collection collection,
 boolean replaceReadRPWithCollectionRP)
                        throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Adjust the Item's policies to reflect what have been defined during the submission/workflow. The temporary SUBMISSION and WORKFLOW policies are removed and the default policies defined at the collection level are inherited as appropriate. Collection's policies are inherited if there are no other policies defined or if the append mode is defined by the configuration via the core.authorization.installitem.inheritance-read.append-mode property

Specified by:

adjustItemPolicies in interface ItemService

Parameters:

context - DSpace context object

item - Item to adjust policies on

collection - Collection

replaceReadRPWithCollectionRP - If true, all read policies on the item are replaced (but only if the collection has a default read policy)

Throws:

SQLException - If database error

AuthorizeException - If authorization error

move

public void move(Context context,
 Item item,
 Collection from,
 Collection to)
          throws SQLException,
AuthorizeException,
IOException

Description copied from interface: ItemService

Moves the item from one collection to another one

Specified by:

move in interface ItemService

Parameters:

context - DSpace context object

item - item to move

from - Collection to move from

to - Collection to move to

Throws:

SQLException - if database error

AuthorizeException - if authorization error

IOException - if IO error

move

public void move(Context context,
 Item item,
 Collection from,
 Collection to,
 boolean inheritDefaultPolicies)
          throws SQLException,
AuthorizeException,
IOException

Description copied from interface: ItemService

Moves the item from one collection to another one

Specified by:

move in interface ItemService

Parameters:

context - DSpace context object

item - item to move

from - Collection to move from

to - Collection to move to

inheritDefaultPolicies - whether to inherit policies from new collection

Throws:

SQLException - if database error

AuthorizeException - if authorization error

IOException - if IO error

hasUploadedFiles

public boolean hasUploadedFiles(Item item)
                         throws SQLException

Description copied from interface: ItemService

Check the bundle ORIGINAL to see if there are any uploaded files

Specified by:

hasUploadedFiles in interface ItemService

Parameters:

item - item to check

Returns:

true if there is a bundle named ORIGINAL with one or more bitstreams inside

Throws:

SQLException - if database error

getCollectionsNotLinked

public List<Collection> getCollectionsNotLinked(Context context,
 Item item)
                                         throws SQLException

Description copied from interface: ItemService

Get the collections this item is not in.

Specified by:

getCollectionsNotLinked in interface ItemService

Parameters:

context - DSpace context object

item - item to check

Returns:

the collections this item is not in, if any.

Throws:

SQLException - if database error

canEdit

public boolean canEdit(Context context,
 Item item)
                throws SQLException

Description copied from interface: ItemService

return TRUE if context's user can edit item, false otherwise

Specified by:

canEdit in interface ItemService

Parameters:

context - DSpace context object

item - item to check

Returns:

boolean true = current user can edit item

Throws:

SQLException - if database error

findItemsWithEdit

public List<Item> findItemsWithEdit(Context context,
 int offset,
 int limit)
                             throws SQLException,
SearchServiceException

Description copied from interface: ItemService

finds all items for which the current user has editing rights

Specified by:

findItemsWithEdit in interface ItemService

Parameters:

context - DSpace context object

offset - page offset

limit - page size limit

Returns:

list of items for which the current user has editing rights

Throws:

SQLException

SearchServiceException

countItemsWithEdit

public int countItemsWithEdit(Context context)
                       throws SQLException,
SearchServiceException

Description copied from interface: ItemService

counts all items for which the current user has editing rights

Specified by:

countItemsWithEdit in interface ItemService

Parameters:

context - DSpace context object

Returns:

list of items for which the current user has editing rights

Throws:

SQLException

SearchServiceException

isInProgressSubmission

public boolean isInProgressSubmission(Context context,
 Item item)
                               throws SQLException

Check if the item is an inprogress submission

Specified by:

isInProgressSubmission in interface ItemService

Parameters:

context - The relevant DSpace Context.

item - item to check

Returns:

true if the item is an inprogress submission, i.e. a WorkspaceItem or WorkflowItem

Throws:

SQLException - An exception that provides information on a database access error or other errors.

addDefaultPoliciesNotInPlace

protected void addDefaultPoliciesNotInPlace(Context context,
 DSpaceObject dso,
 List<ResourcePolicy> defaultCollectionPolicies)
                                     throws SQLException,
AuthorizeException

Add the default policies, which have not been already added to the given DSpace object

Parameters:

context - The relevant DSpace Context.

dso - The DSpace Object to add policies to

defaultCollectionPolicies - list of policies

Throws:

SQLException - An exception that provides information on a database access error or other errors.

AuthorizeException - Exception indicating the current user of the context does not have permission to perform a particular action.

findArchivedByMetadataField

public Iterator<Item> findArchivedByMetadataField(Context context,
 String schema,
 String element,
 String qualifier,
 String value)
                                           throws SQLException,
AuthorizeException

Returns an iterator of Items possessing the passed metadata field, or only those matching the passed value, if value is not Item.ANY

Specified by:

findArchivedByMetadataField in interface ItemService

Parameters:

context - DSpace context object

schema - metadata field schema

element - metadata field element

qualifier - metadata field qualifier

value - field value or Item.ANY to match any value

Returns:

an iterator over the items matching that authority value

Throws:

SQLException - if database error An exception that provides information on a database access error or other errors.

AuthorizeException - if authorization error Exception indicating the current user of the context does not have permission to perform a particular action.

findArchivedByMetadataField

public Iterator<Item> findArchivedByMetadataField(Context context,
 String metadataField,
 String value)
                                           throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Returns an iterator of in archive items possessing the passed metadata field, or only those matching the passed value, if value is not Item.ANY

Specified by:

findArchivedByMetadataField in interface ItemService

Parameters:

context - DSpace context object

metadataField - metadata

value - field value or Item.ANY to match any value

Returns:

an iterator over the items matching that authority value

Throws:

SQLException - if database error

AuthorizeException - if authorization error

findByMetadataField

public Iterator<Item> findByMetadataField(Context context,
 String schema,
 String element,
 String qualifier,
 String value)
                                   throws SQLException,
AuthorizeException,
IOException

Returns an iterator of Items possessing the passed metadata field, or only those matching the passed value, if value is not Item.ANY

Specified by:

findByMetadataField in interface ItemService

Parameters:

context - DSpace context object

schema - metadata field schema

element - metadata field element

qualifier - metadata field qualifier

value - field value or Item.ANY to match any value

Returns:

an iterator over the items matching that authority value

Throws:

SQLException - if database error An exception that provides information on a database access error or other errors.

AuthorizeException - if authorization error Exception indicating the current user of the context does not have permission to perform a particular action.

IOException - if IO error A general class of exceptions produced by failed or interrupted I/O operations.

findByMetadataQuery

public List<Item> findByMetadataQuery(Context context,
 List<QueryPredicate> queryPredicates,
 List<UUID> collectionUuids,
 long offset,
 int limit)
                               throws SQLException

Description copied from interface: ItemService

Returns a list of items that match the given predicates, within the specified collections, if any. This querying method is used by the Filtered Items report functionality.

Specified by:

findByMetadataQuery in interface ItemService

Parameters:

context - DSpace context object

queryPredicates - metadata field predicates

collectionUuids - UUIDs of the collections to search

offset - position in the list to start returning items

limit - maximum number of items to return

Returns:

a list of matching items in the specified collections, or in any collection if no collection UUIDs are provided

Throws:

SQLException - if a database error occurs

countForMetadataQuery

public long countForMetadataQuery(Context context,
 List<QueryPredicate> queryPredicates,
 List<UUID> collectionUuids)
                           throws SQLException

Description copied from interface: ItemService

Returns the total number of items that match the given predicates, within the specified collections, if any. This querying method is used for pagination by the Filtered Items report functionality.

Specified by:

countForMetadataQuery in interface ItemService

Parameters:

context - DSpace context object

queryPredicates - metadata field predicates

collectionUuids - UUIDs of the collections to search

Returns:

the total number of matching items in the specified collections, or in any collection if no collection UUIDs are provided

Throws:

SQLException - if a database error occurs

getAdminObject

public DSpaceObject getAdminObject(Context context,
 Item item,
 int action)
                            throws SQLException

Description copied from interface: DSpaceObjectService

Return the dspace object where an ADMIN action right is sufficient to grant the initial authorize check.

Default behaviour is ADMIN right on the object grant right on all other action on the object itself. Subclass should override this method as needed.

Specified by:

getAdminObject in interface DSpaceObjectService<Item>

Overrides:

getAdminObject in class DSpaceObjectServiceImpl<Item>

Parameters:

context - DSpace context

item - DSpaceObject

action - ID of action being attempted, from org.dspace.core.Constants. The ADMIN action is not a valid parameter for this method, an IllegalArgumentException should be thrown

Returns:

the dspace object, if any, where an ADMIN action is sufficient to grant the original action

Throws:

SQLException - if database error

getParentObject

public DSpaceObject getParentObject(Context context,
 Item item)
                             throws SQLException

Description copied from interface: DSpaceObjectService

Return the dspace object that "own" the current object in the hierarchy. Note that this method has a meaning slightly different from the getAdminObject because it is independent of the action but it is in a way related to it. It defines the "first" dspace object OTHER then the current one, where allowed ADMIN actions imply allowed ADMIN actions on the object self.

Specified by:

getParentObject in interface DSpaceObjectService<Item>

Overrides:

getParentObject in class DSpaceObjectServiceImpl<Item>

Parameters:

context - DSpace context

item - DSpaceObject

Returns:

the dspace object that "own" the current object in the hierarchy

Throws:

SQLException - if database error

findByAuthorityValue

public Iterator<Item> findByAuthorityValue(Context context,
 String schema,
 String element,
 String qualifier,
 String value)
                                    throws SQLException,
AuthorizeException

Description copied from interface: ItemService

Find all the items in the archive with a given authority key value in the indicated metadata field.

Specified by:

findByAuthorityValue in interface ItemService

Parameters:

context - DSpace context object

schema - metadata field schema

element - metadata field element

qualifier - metadata field qualifier

value - the value of authority key to look for

Returns:

an iterator over the items matching that authority value

Throws:

SQLException - if database error

AuthorizeException - if authorization error

findByMetadataFieldAuthority

public Iterator<Item> findByMetadataFieldAuthority(Context context,
 String mdString,
 String authority)
                                            throws SQLException,
AuthorizeException

Specified by:

findByMetadataFieldAuthority in interface ItemService

Throws:

SQLException

AuthorizeException

isItemListedForUser

public boolean isItemListedForUser(Context context,
 Item item)

Description copied from interface: ItemService

Service method for knowing if this Item should be visible in the item list. Items only show up in the "item list" if the user has READ permission and if the Item isn't flagged as unlisted.

Specified by:

isItemListedForUser in interface ItemService

Parameters:

context - DSpace context object

item - item

Returns:

true or false

countItems

public int countItems(Context context,
 Collection collection)
               throws SQLException

Description copied from interface: ItemService

counts items in the given collection

Specified by:

countItems in interface ItemService

Parameters:

context - DSpace context object

collection - Collection

Returns:

total items

Throws:

SQLException - if database error

countAllItems

public int countAllItems(Context context,
 Collection collection)
                  throws SQLException

Description copied from interface: ItemService

counts all items in the given collection including withdrawn items

Specified by:

countAllItems in interface ItemService

Parameters:

context - DSpace context object

collection - Collection

Returns:

total items

Throws:

SQLException - if database error

countItems

public int countItems(Context context,
 Community community)
               throws SQLException

Description copied from interface: ItemService

counts items in the given community

Specified by:

countItems in interface ItemService

Parameters:

context - DSpace context object

community - Community

Returns:

total items

Throws:

SQLException - if database error

countAllItems

public int countAllItems(Context context,
 Community community)
                  throws SQLException

Description copied from interface: ItemService

counts all items in the given community including withdrawn

Specified by:

countAllItems in interface ItemService

Parameters:

context - DSpace context object

community - Community

Returns:

total items

Throws:

SQLException - if database error

getAuthoritiesAndConfidences

protected void getAuthoritiesAndConfidences(String fieldKey,
 Collection collection,
 List<String> values,
 List<String> authorities,
 List<Integer> confidences,
 int i)

Overrides:

getAuthoritiesAndConfidences in class DSpaceObjectServiceImpl<Item>

findByIdOrLegacyId

public Item findByIdOrLegacyId(Context context,
 String id)
                        throws SQLException

Specified by:

findByIdOrLegacyId in interface DSpaceObjectLegacySupportService<Item>

Throws:

SQLException

findByLegacyId

public Item findByLegacyId(Context context,
 int id)
                    throws SQLException

Description copied from interface: DSpaceObjectLegacySupportService

Generic find for when the precise type of a DSO is not known, just the a pair of type number and database ID.

Specified by:

findByLegacyId in interface DSpaceObjectLegacySupportService<Item>

Parameters:

context - - the context

id - - the legacy id within table of type'd objects

Returns:

the object found, or null if it does not exist.

Throws:

SQLException - only upon failure accessing the database.

findByLastModifiedSince

public Iterator<Item> findByLastModifiedSince(Context context,
 Instant last)
                                       throws SQLException

Description copied from interface: ItemService

Find all Items modified since a Date.

Specified by:

findByLastModifiedSince in interface ItemService

Parameters:

context - DSpace context object

last - Earliest interesting last-modified date.

Returns:

iterator over items

Throws:

SQLException - if database error

countTotal

public int countTotal(Context context)
               throws SQLException

Description copied from interface: ItemService

counts all items

Specified by:

countTotal in interface ItemService

Parameters:

context - DSpace context object

Returns:

total items

Throws:

SQLException - if database error

countNotArchivedItems

public int countNotArchivedItems(Context context)
                          throws SQLException

Description copied from interface: ItemService

counts all items not in archive

Specified by:

countNotArchivedItems in interface ItemService

Parameters:

context - DSpace context object

Returns:

total items NOT in archive

Throws:

SQLException - if database error

countArchivedItems

public int countArchivedItems(Context context)
                       throws SQLException

Description copied from interface: ItemService

counts all items in archive

Specified by:

countArchivedItems in interface ItemService

Parameters:

context - DSpace context object

Returns:

total items in archive

Throws:

SQLException - if database error

countWithdrawnItems

public int countWithdrawnItems(Context context)
                        throws SQLException

Description copied from interface: ItemService

counts all withdrawn items

Specified by:

countWithdrawnItems in interface ItemService

Parameters:

context - DSpace context object

Returns:

total items withdrawn

Throws:

SQLException - if database error

canCreateNewVersion

public boolean canCreateNewVersion(Context context,
 Item item)
                            throws SQLException

Description copied from interface: ItemService

return TRUE if context's user can create new version of the item, false otherwise.

Specified by:

canCreateNewVersion in interface ItemService

Parameters:

context - DSpace context object

item - item to check

Returns:

boolean true = current user can create new version of the item

Throws:

SQLException - if database error

getMetadata

public List<MetadataValue> getMetadata(Item item,
 String schema,
 String element,
 String qualifier,
 String lang)

This method will return a list of MetadataValue objects that contains all the regular metadata of the item passed along in the parameters as well as all the virtual metadata which will be generated and processed together with the VirtualMetadataPopulator by processing the item's relationships

Specified by:

getMetadata in interface DSpaceObjectService<Item>

Overrides:

getMetadata in class DSpaceObjectServiceImpl<Item>

Parameters:

item - the Item to be processed

schema - the schema for the metadata field. Must match the name of an existing metadata schema.

element - the element name. DSpaceObject.ANY matches any element. null doesn't really make sense as all metadata must have an element.

qualifier - the qualifier. null means unqualified, and DSpaceObject.ANY means any qualifier (including unqualified.)

lang - the ISO639 language code, optionally followed by an underscore and the ISO3166 country code. null means only values with no language are returned, and DSpaceObject.ANY means values with any country code or no country code are returned.

Returns:

getMetadata

public List<MetadataValue> getMetadata(Item item,
 String schema,
 String element,
 String qualifier,
 String lang,
 boolean enableVirtualMetadata)

Description copied from interface: ItemService

Get metadata for the DSpace Object in a chosen schema. See MetadataSchema for more information about schemas. Passing in a null value for qualifier or lang only matches metadata fields where that qualifier or languages is actually null. Passing in DSpaceObject.ANY retrieves all metadata fields with any value for the qualifier or language, including null

Examples:

Return values of the unqualified "title" field, in any language. Qualified title fields (e.g. "title.uniform") are NOT returned:

dspaceobject.getMetadataByMetadataString("dc", "title", null, DSpaceObject.ANY );

Return all US English values of the "title" element, with any qualifier (including unqualified):

dspaceobject.getMetadataByMetadataString("dc, "title", DSpaceObject.ANY, "en_US" );

The ordering of values of a particular element/qualifier/language combination is significant. When retrieving with wildcards, values of a particular element/qualifier/language combinations will be adjacent, but the overall ordering of the combinations is indeterminate. If enableVirtualMetadata is set to false, the virtual metadata will not be included

Specified by:

getMetadata in interface ItemService

Parameters:

item - Item

schema - the schema for the metadata field. Must match the name of an existing metadata schema.

element - the element name. DSpaceObject.ANY matches any element. null doesn't really make sense as all metadata must have an element.

qualifier - the qualifier. null means unqualified, and DSpaceObject.ANY means any qualifier (including unqualified.)

lang - the ISO639 language code, optionally followed by an underscore and the ISO3166 country code. null means only values with no language are returned, and DSpaceObject.ANY means values with any country code or no country code are returned.

enableVirtualMetadata - Enables virtual metadata calculation and inclusion from the relationships.

Returns:

metadata fields that match the parameters

moveSingleMetadataValue

protected void moveSingleMetadataValue(Context context,
 Item dso,
 int place,
 MetadataValue rr)

Supports moving metadata by adding the metadata value or updating the place of the relationship

Overrides:

moveSingleMetadataValue in class DSpaceObjectServiceImpl<Item>

Parameters:

context - current DSpace session.

dso - unused.

place - ordinal position of the value in the list of that field's values.

rr - the value to be placed.

addMetadata

public MetadataValue addMetadata(Context context,
 Item dso,
 String schema,
 String element,
 String qualifier,
 String lang,
 String value,
 String authority,
 int confidence,
 int place)
                          throws SQLException

Description copied from interface: DSpaceObjectService

Add a single metadata value at the given place position.

Specified by:

addMetadata in interface DSpaceObjectService<Item>

Overrides:

addMetadata in class DSpaceObjectServiceImpl<Item>

Parameters:

context - DSpace context

dso - DSpaceObject

schema - the schema for the metadata field. Must match the name of an existing metadata schema.

element - the metadata element name

qualifier - the metadata qualifier, or null for unqualified

lang - the ISO639 language code, optionally followed by an underscore and the ISO3166 country code. null means the value has no language (for example, a date).

value - the value to add.

authority - the external authority key for this value (or null)

confidence - the authority confidence (default 0)

place - the metadata position

Returns:

the MetadataValue added ot the object

Throws:

SQLException - if database error

getEntityTypeLabel

public String getEntityTypeLabel(Item item)

Description copied from interface: ItemService

Retrieve the label of the entity type of the given item.

Specified by:

getEntityTypeLabel in interface ItemService

Parameters:

item - the item.

Returns:

the label of the entity type, taken from the item metadata, or null if not found.

getEntityType

public EntityType getEntityType(Context context,
 Item item)
                         throws SQLException

Description copied from interface: ItemService

Retrieve the entity type of the given item.

Specified by:

getEntityType in interface ItemService

Parameters:

context - the DSpace context.

item - the item.

Returns:

the entity type of the given item, or null if not found.

Throws:

SQLException

isLatestVersion

public boolean isLatestVersion(Context context,
 Item item)
                        throws SQLException

Description copied from interface: ItemService

Check whether the given item is the latest version. If the latest item cannot be determined, because either the version history or the latest version is not present, assume the item is latest.

Specified by:

isLatestVersion in interface ItemService

Parameters:

context - the DSpace context.

item - the item that should be checked.

Returns:

true if the item is the latest version, false otherwise.

Throws:

SQLException