org.dspace.content

Class DSpaceObjectServiceImpl<T extends DSpaceObject>

java.lang.Object

org.dspace.content.DSpaceObjectServiceImpl<T>

Type Parameters:

T - class type

All Implemented Interfaces:

DSpaceObjectService<T>

Direct Known Subclasses:

BitstreamServiceImpl, BundleServiceImpl, CollectionServiceImpl, CommunityServiceImpl, EPersonServiceImpl, GroupServiceImpl, ItemServiceImpl, SiteServiceImpl

public abstract class DSpaceObjectServiceImpl<T extends DSpaceObject>
extends Object
implements DSpaceObjectService<T>

Service implementation class for the DSpaceObject. All DSpaceObject service classes should extend this class since it implements some basic methods which all DSpaceObjects are required to have.

Author:

kevinvandevelde at atmire.com

Field Summary

Fields

Modifier and Type	Field and Description
protected ChoiceAuthorityService	choiceAuthorityService
protected HandleService	handleService
protected MetadataAuthorityService	metadataAuthorityService
protected MetadataFieldService	metadataFieldService
protected MetadataValueService	metadataValueService

Constructor Summary

Constructors

Constructor and Description
DSpaceObjectServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addMetadata(Context context, T dso, MetadataField metadataField, String language, List<String> values)
void	addMetadata(Context context, T dso, MetadataField metadataField, String lang, List<String> values, List<String> authorities, List<Integer> confidences) Add metadata fields.
void	addMetadata(Context context, T dso, MetadataField metadataField, String language, String value)
void	addMetadata(Context context, T dso, MetadataField metadataField, String language, String value, String authority, int confidence)
void	addMetadata(Context context, T dso, String schema, String element, String qualifier, String lang, List<String> values) Add metadata fields.
void	addMetadata(Context context, T dso, String schema, String element, String qualifier, String lang, List<String> values, List<String> authorities, List<Integer> confidences) Add metadata fields.
void	addMetadata(Context context, T dso, String schema, String element, String qualifier, String lang, String value) Add a single metadata field.
void	addMetadata(Context context, T dso, String schema, String element, String qualifier, String lang, String value, String authority, int confidence) Add a single metadata field.
void	clearMetadata(Context context, T dso, String schema, String element, String qualifier, String lang) Clear metadata values.
DSpaceObject	getAdminObject(Context context, T dso, 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)
protected String[]	getElements(String fieldName) Splits "schema.element.qualifier.language" into an array.
protected String[]	getElementsFilled(String fieldName) Splits "schema.element.qualifier.language" into an array.
ArrayList<String>	getIdentifiers(Context context, T dso) Tries to lookup all Identifiers of this DSpaceObject.
protected String[]	getMDValueByField(String field)
protected String[]	getMDValueByLegacyField(String field)
String	getMetadata(T dso, String value) Get the value of a metadata field
List<MetadataValue>	getMetadata(T dso, String mdString, String authority)
List<MetadataValue>	getMetadata(T dso, String schema, String element, String qualifier, String lang) Get metadata for the DSpace Object in a chosen schema.
List<MetadataValue>	getMetadata(T dso, String schema, String element, String qualifier, String lang, String authority)
List<MetadataValue>	getMetadataByMetadataString(T dso, String mdString) Retrieve metadata field values from a given metadata string of the form <schema prefix>.<element>[.<qualifier>|.*]
String	getMetadataFirstValue(T dso, String schema, String element, String qualifier, String language) Retrieve first metadata field value
protected int	getMetadataValuePlace(Map<MetadataField,Integer> fieldToLastPlace, MetadataValue metadataValue) Retrieve the place of the metadata value
String	getName(T dso) Get a proper name for the object.
DSpaceObject	getParentObject(Context context, T dso) Return the dspace object that "own" the current object in the hierarchy.
String	getTypeText(T dso) Provide the text name of the type of this DSpaceObject.
protected boolean	match(String schema, String element, String qualifier, String language, MetadataValue metadataValue) Utility method for pattern-matching metadata elements.
void	removeMetadataValues(Context context, T dso, List<MetadataValue> values)
void	setMetadataSingleValue(Context context, T dso, String schema, String element, String qualifier, String language, String value) Set first metadata field value
void	update(Context context, T dso)

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

delete, find, getSupportsTypeConstant, updateLastModified

Field Detail

choiceAuthorityService

@Autowired(required=true)
protected ChoiceAuthorityService choiceAuthorityService

handleService

@Autowired(required=true)
protected HandleService handleService

metadataValueService

@Autowired(required=true)
protected MetadataValueService metadataValueService

metadataFieldService

@Autowired(required=true)
protected MetadataFieldService metadataFieldService

metadataAuthorityService

@Autowired(required=true)
protected MetadataAuthorityService metadataAuthorityService

Constructor Detail

DSpaceObjectServiceImpl

public DSpaceObjectServiceImpl()

Method Detail

getName

public String getName(T dso)

Description copied from interface: DSpaceObjectService

Get a proper name for the object. This may return null. Name should be suitable for display in a user interface.

Specified by:

getName in interface DSpaceObjectService<T extends DSpaceObject>

Parameters:

dso - DSpaceObject

Returns:

Name for the object, or null if it doesn't have one

getIdentifiers

public ArrayList<String> getIdentifiers(Context context,
                               T dso)

Description copied from interface: DSpaceObjectService

Tries to lookup all Identifiers of this DSpaceObject.

Specified by:

getIdentifiers in interface DSpaceObjectService<T extends DSpaceObject>

Parameters:

context - DSpace context

dso - DSpaceObject

Returns:

An array containing all found identifiers or an array with a length of 0.

getParentObject

public DSpaceObject getParentObject(Context context,
                           T dso)
                             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<T extends DSpaceObject>

Parameters:

context - DSpace context

dso - DSpaceObject

Returns:

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

Throws:

SQLException - if database error

getAdminObject

public DSpaceObject getAdminObject(Context context,
                          T dso,
                          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<T extends DSpaceObject>

Parameters:

context - DSpace context

dso - 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

getTypeText

public String getTypeText(T dso)

Description copied from interface: DSpaceObjectService

Provide the text name of the type of this DSpaceObject. It is most likely all uppercase.

Specified by:

getTypeText in interface DSpaceObjectService<T extends DSpaceObject>

Parameters:

dso - DSpaceObject

Returns:

Object type as text

getMetadata

public List<MetadataValue> getMetadata(T dso,
                              String schema,
                              String element,
                              String qualifier,
                              String lang)

Description copied from interface: DSpaceObjectService

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.

Specified by:

getMetadata in interface DSpaceObjectService<T extends DSpaceObject>

Parameters:

dso - DSpaceObject

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:

metadata fields that match the parameters

getMetadataByMetadataString

public List<MetadataValue> getMetadataByMetadataString(T dso,
                                              String mdString)

Description copied from interface: DSpaceObjectService

Retrieve metadata field values from a given metadata string of the form <schema prefix>.<element>[.<qualifier>|.*]

Specified by:

getMetadataByMetadataString in interface DSpaceObjectService<T extends DSpaceObject>

Parameters:

dso - DSpaceObject

mdString - The metadata string of the form <schema prefix>.<element>[.<qualifier>|.*]

Returns:

metadata fields that match the parameters

getMetadata

public String getMetadata(T dso,
                 String value)

Description copied from interface: DSpaceObjectService

Get the value of a metadata field

Specified by:

getMetadata in interface DSpaceObjectService<T extends DSpaceObject>

Parameters:

dso - DSpaceObject

value - the name of the metadata field to get

Returns:

the value of the metadata field (or null if the column is an SQL NULL)

getMetadata

public List<MetadataValue> getMetadata(T dso,
                              String mdString,
                              String authority)

Specified by:

getMetadata in interface DSpaceObjectService<T extends DSpaceObject>

getMetadata

public List<MetadataValue> getMetadata(T dso,
                              String schema,
                              String element,
                              String qualifier,
                              String lang,
                              String authority)

Specified by:

getMetadata in interface DSpaceObjectService<T extends DSpaceObject>

addMetadata

public void addMetadata(Context context,
               T dso,
               String schema,
               String element,
               String qualifier,
               String lang,
               List<String> values)
                 throws SQLException

Description copied from interface: DSpaceObjectService

Add metadata fields. These are appended to existing values. Use clearDC to remove values. The ordering of values passed in is maintained.

If metadata authority control is available, try to get authority values. The authority confidence depends on whether authority is required or not.

Specified by:

addMetadata in interface DSpaceObjectService<T extends DSpaceObject>

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 name, 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).

values - the values to add.

Throws:

SQLException - if database error

addMetadata

public void addMetadata(Context context,
               T dso,
               String schema,
               String element,
               String qualifier,
               String lang,
               List<String> values,
               List<String> authorities,
               List<Integer> confidences)
                 throws SQLException

Description copied from interface: DSpaceObjectService

Add metadata fields. These are appended to existing values. Use clearDC to remove values. The ordering of values passed in is maintained.

Specified by:

addMetadata in interface DSpaceObjectService<T extends DSpaceObject>

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 name, 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).

values - the values to add.

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

confidences - the authority confidence (default 0)

Throws:

SQLException - if database error

addMetadata

public void addMetadata(Context context,
               T dso,
               MetadataField metadataField,
               String lang,
               List<String> values,
               List<String> authorities,
               List<Integer> confidences)
                 throws SQLException

Description copied from interface: DSpaceObjectService

Add metadata fields. These are appended to existing values. Use clearDC to remove values. The ordering of values passed in is maintained.

Specified by:

addMetadata in interface DSpaceObjectService<T extends DSpaceObject>

Parameters:

context - DSpace context

dso - DSpaceObject

metadataField - the metadata field to which the value is to be set

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).

values - the values to add.

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

confidences - the authority confidence (default 0)

Throws:

SQLException - if database error

addMetadata

public void addMetadata(Context context,
               T dso,
               MetadataField metadataField,
               String language,
               String value,
               String authority,
               int confidence)
                 throws SQLException

Specified by:

addMetadata in interface DSpaceObjectService<T extends DSpaceObject>

Throws:

SQLException

addMetadata

public void addMetadata(Context context,
               T dso,
               String schema,
               String element,
               String qualifier,
               String lang,
               String value)
                 throws SQLException

Description copied from interface: DSpaceObjectService

Add a single metadata field. This is appended to existing values. Use clearDC to remove values.

Specified by:

addMetadata in interface DSpaceObjectService<T extends DSpaceObject>

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.

Throws:

SQLException - if database error

addMetadata

public void addMetadata(Context context,
               T dso,
               MetadataField metadataField,
               String language,
               String value)
                 throws SQLException

Specified by:

addMetadata in interface DSpaceObjectService<T extends DSpaceObject>

Throws:

SQLException

addMetadata

public void addMetadata(Context context,
               T dso,
               MetadataField metadataField,
               String language,
               List<String> values)
                 throws SQLException

Specified by:

addMetadata in interface DSpaceObjectService<T extends DSpaceObject>

Throws:

SQLException

addMetadata

public void addMetadata(Context context,
               T dso,
               String schema,
               String element,
               String qualifier,
               String lang,
               String value,
               String authority,
               int confidence)
                 throws SQLException

Description copied from interface: DSpaceObjectService

Add a single metadata field. This is appended to existing values. Use clearDC to remove values.

Specified by:

addMetadata in interface DSpaceObjectService<T extends DSpaceObject>

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)

Throws:

SQLException - if database error

clearMetadata

public void clearMetadata(Context context,
                 T dso,
                 String schema,
                 String element,
                 String qualifier,
                 String lang)
                   throws SQLException

Description copied from interface: DSpaceObjectService

Clear metadata values. As with getDC above, passing in null only matches fields where the qualifier or language is actually null.Item.ANY will match any element, qualifier or language, including null. Thus, dspaceobject.clearDC(Item.ANY, Item.ANY, Item.ANY) will remove all Dublin Core metadata associated with an DSpaceObject.

Specified by:

clearMetadata in interface DSpaceObjectService<T extends DSpaceObject>

Parameters:

context - DSpace context

dso - DSpaceObject

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

element - the Dublin Core element to remove, or Item.ANY

qualifier - the qualifier. null means unqualified, and Item.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 removed, and Item.ANY means values with any country code or no country code are removed.

Throws:

SQLException - if database error

removeMetadataValues

public void removeMetadataValues(Context context,
                        T dso,
                        List<MetadataValue> values)
                          throws SQLException

Specified by:

removeMetadataValues in interface DSpaceObjectService<T extends DSpaceObject>

Throws:

SQLException

getMetadataFirstValue

public String getMetadataFirstValue(T dso,
                           String schema,
                           String element,
                           String qualifier,
                           String language)

Retrieve first metadata field value

Specified by:

getMetadataFirstValue in interface DSpaceObjectService<T extends DSpaceObject>

Parameters:

dso -

language -

element -

schema -

qualifier -

Returns:

setMetadataSingleValue

public void setMetadataSingleValue(Context context,
                          T dso,
                          String schema,
                          String element,
                          String qualifier,
                          String language,
                          String value)
                            throws SQLException

Set first metadata field value

Specified by:

setMetadataSingleValue in interface DSpaceObjectService<T extends DSpaceObject>

Parameters:

context - DSpace context

dso - DSpaceObject

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

element - the Dublin Core element to remove, or Item.ANY

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

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

value - metadata value

Throws:

SQLException - if database error

match

protected boolean match(String schema,
            String element,
            String qualifier,
            String language,
            MetadataValue metadataValue)

Utility method for pattern-matching metadata elements. This method will return true if the given schema, element, qualifier and language match the schema, element, qualifier and language of the DCValue object passed in. Any or all of the element, qualifier and language passed in can be the Item.ANY wildcard.

Parameters:

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

element - the element to match, or Item.ANY

qualifier - the qualifier to match, or Item.ANY

language - the language to match, or Item.ANY

metadataValue - the Dublin Core value

Returns:

true if there is a match

getAuthoritiesAndConfidences

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

getElements

protected String[] getElements(String fieldName)

Splits "schema.element.qualifier.language" into an array.

The returned array will always have length greater than or equal to 4

Values in the returned array can be empty or null.

Parameters:

fieldName - field name

Returns:

array

getElementsFilled

protected String[] getElementsFilled(String fieldName)

Splits "schema.element.qualifier.language" into an array.

The returned array will always have length greater than or equal to 4

When @param fill is true, elements that would be empty or null are replaced by Item.ANY

Parameters:

fieldName - field name

Returns:

array

getMDValueByField

protected String[] getMDValueByField(String field)

update

public void update(Context context,
          T dso)
            throws SQLException,
                   AuthorizeException

Specified by:

update in interface DSpaceObjectService<T extends DSpaceObject>

Throws:

SQLException

AuthorizeException

getMetadataValuePlace

protected int getMetadataValuePlace(Map<MetadataField,Integer> fieldToLastPlace,
                        MetadataValue metadataValue)

Retrieve the place of the metadata value

Parameters:

fieldToLastPlace - the map containing the latest place of each metadata field

metadataValue - the metadata value that needs to get a place

Returns:

The new place for the metadata valu

getMDValueByLegacyField

protected String[] getMDValueByLegacyField(String field)