org.dspace.content

Class DSpaceObject

java.lang.Object

org.dspace.content.DSpaceObject

Direct Known Subclasses:

Bitstream, BrowseItem, Bundle, Collection, Community, EPerson, Group, Item, Site

public abstract class DSpaceObject
extends Object

Abstract base class for DSpace objects

Field Summary

Fields

Modifier and Type	Field and Description
protected MetadataField[]	allMetadataFields
protected org.dspace.content.DSpaceObject.MetadataCache	metadataCache The Dublin Core metadata - inner class for lazy loading
protected boolean	modifiedMetadata True if anything else was changed since last update() (to drive event mechanism)
protected Context	ourContext Our context

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DSpaceObject() Construct a DSpaceOBject with the given table row
protected	DSpaceObject(Context context)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDC(String element, String qualifier, String lang, String value) Deprecated.
void	addDC(String element, String qualifier, String lang, String[] values) Deprecated.
protected void	addDetails(String d) Add a string to the cache of event details.
void	addMetadata(String schema, String element, String qualifier, String lang, String value) Add a single metadata field.
void	addMetadata(String schema, String element, String qualifier, String lang, String[] values) Add metadata fields.
void	addMetadata(String schema, String element, String qualifier, String lang, String[] values, String[] authorities, int[] confidences) Add metadata fields.
void	addMetadata(String schema, String element, String qualifier, String lang, String value, String authority, int confidence) Add a single metadata field.
void	clearDC(String element, String qualifier, String lang) Deprecated.
protected void	clearDetails() Reset the cache of event details.
void	clearMetadata(String schema, String element, String qualifier, String lang) Clear metadata values.
static DSpaceObject	find(Context context, int type, 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.
DSpaceObject	getAdminObject(int action) Return the dspace object where an ADMIN action right is sufficient to grant the initial authorize check.
protected void	getAuthoritiesAndConfidences(String fieldKey, String[] values, String[] authorities, int[] confidences, int i)
Metadatum[]	getDC(String element, String qualifier, String lang) Deprecated.
protected String	getDetails()
static String[]	getElements(String fieldName) Splits "schema.element.qualifier.language" into an array.
static String[]	getElementsFilled(String fieldName) Splits "schema.element.qualifier.language" into an array.
abstract String	getHandle() Get the Handle of the object.
abstract int	getID() Get the internal ID (database primary key) of this object
String[]	getIdentifiers(Context context) Tries to lookup all Identifiers of this DSpaceObject.
protected String[]	getMDValueByField(String field)
protected String[]	getMDValueByLegacyField(String field)
protected List<Metadatum>	getMetadata()
String	getMetadata(String value) Get the value of a metadata field
List<Metadatum>	getMetadata(String mdString, String authority)
Metadatum[]	getMetadata(String schema, String element, String qualifier, String lang) Get metadata for the DSpace Object in a chosen schema.
List<Metadatum>	getMetadata(String schema, String element, String qualifier, String lang, String authority)
Metadatum[]	getMetadataByMetadataString(String mdString) Retrieve metadata field values from a given metadata string of the form .[.|.*]
protected MetadataField	getMetadataField(Metadatum dcv)
protected String	getMetadataFirstValue(String schema, String element, String qualifier, String language) Retrieve first metadata field value
abstract String	getName() Get a proper name for the object.
DSpaceObject	getParentObject() Return the dspace object that "own" the current object in the hierarchy.
abstract int	getType() Get the type of this object, found in Constants
String	getTypeText() Provide the text name of the type of this DSpaceObject.
protected void	removeMetadataFromDatabase() Utility method to remove all descriptive metadata associated with the DSpaceObject from the database (regardless of in-memory version)
void	replaceMetadataValue(Metadatum oldValue, Metadatum newValue)
void	resetIdentifiersCache()
protected void	setMetadataSingleValue(String schema, String element, String qualifier, String language, String value) Set first metadata field value
abstract void	update()
abstract void	updateLastModified()
void	updateMetadata()

Methods inherited from class java.lang.Object

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

Field Detail

ourContext

protected Context ourContext

Our context

modifiedMetadata

protected boolean modifiedMetadata

True if anything else was changed since last update() (to drive event mechanism)

metadataCache

protected org.dspace.content.DSpaceObject.MetadataCache metadataCache

The Dublin Core metadata - inner class for lazy loading

allMetadataFields

protected transient MetadataField[] allMetadataFields

Constructor Detail

DSpaceObject

protected DSpaceObject()

Construct a DSpaceOBject with the given table row

Throws:

SQLException

DSpaceObject

protected DSpaceObject(Context context)

Method Detail

updateMetadata

public void updateMetadata()
                    throws SQLException,
                           AuthorizeException

Throws:

SQLException

AuthorizeException

clearDetails

protected void clearDetails()

Reset the cache of event details.

addDetails

protected void addDetails(String d)

Add a string to the cache of event details. Automatically separates entries with a comma. Subclass can just start calling addDetails, since it creates the cache if it needs to.

Parameters:

d - detail string to add.

getDetails

protected String getDetails()

Returns:

summary of event details, or null if there are none.

getType

public abstract int getType()

Get the type of this object, found in Constants

Returns:

type of the object

getTypeText

public String getTypeText()

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

Returns:

Object type as text

getID

public abstract int getID()

Get the internal ID (database primary key) of this object

Returns:

internal ID of object

getHandle

public abstract String getHandle()

Get the Handle of the object. This may return null

Returns:

Handle of the object, or null if it doesn't have one

getName

public abstract String getName()

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

Returns:

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

getIdentifiers

public String[] getIdentifiers(Context context)

Tries to lookup all Identifiers of this DSpaceObject.

Returns:

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

resetIdentifiersCache

public void resetIdentifiersCache()

find

public static DSpaceObject find(Context context,
                int type,
                int id)
                         throws SQLException

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

Parameters:

context - - the context

type - - type number

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

getAdminObject

public DSpaceObject getAdminObject(int action)
                            throws SQLException

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.

Parameters:

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

IllegalArgumentException - if the ADMIN action is supplied as parameter of the method call

getParentObject

public DSpaceObject getParentObject()
                             throws SQLException

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.

Returns:

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

Throws:

SQLException

update

public abstract void update()
                     throws SQLException,
                            AuthorizeException

Throws:

SQLException

AuthorizeException

updateLastModified

public abstract void updateLastModified()

getDC

@Deprecated
public Metadatum[] getDC(String element,
                           String qualifier,
                           String lang)

Deprecated.

Get Dublin Core metadata for the DSpace Object. Passing in a null value for qualifier or lang only matches Dublin Core 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.getDC( "title", null, DSpaceObject.ANY );

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

dspaceobject.getDC( "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.

Parameters:

element - the Dublin Core element. DSpaceObject.ANY matches any element. null doesn't really make sense as all DC 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:

Dublin Core fields that match the parameters

getMetadata

public Metadatum[] getMetadata(String schema,
                      String element,
                      String qualifier,
                      String lang)

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.

Parameters:

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 Metadatum[] getMetadataByMetadataString(String mdString)

Retrieve metadata field values from a given metadata string of the form .[.|.*]

Parameters:

mdString - The metadata string of the form .[.|.*]

getMetadataFirstValue

protected String getMetadataFirstValue(String schema,
                           String element,
                           String qualifier,
                           String language)

Retrieve first metadata field value

setMetadataSingleValue

protected void setMetadataSingleValue(String schema,
                          String element,
                          String qualifier,
                          String language,
                          String value)

Set first metadata field value

getMetadata

protected List<Metadatum> getMetadata()

getMetadata

public String getMetadata(String value)

Get the value of a metadata field

Parameters:

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)

Throws:

IllegalArgumentException - if the requested metadata field doesn't exist

getMetadata

public List<Metadatum> getMetadata(String mdString,
                          String authority)

getMetadata

public List<Metadatum> getMetadata(String schema,
                          String element,
                          String qualifier,
                          String lang,
                          String authority)

getElements

public static String[] getElements(String fieldName)

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

The returned array will always have length >= 4

Values in the returned array can be empty or null.

getElementsFilled

public static String[] getElementsFilled(String fieldName)

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

The returned array will always have length >= 4

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

replaceMetadataValue

public void replaceMetadataValue(Metadatum oldValue,
                        Metadatum newValue)

addDC

@Deprecated
public void addDC(String element,
                    String qualifier,
                    String lang,
                    String[] values)

Deprecated.

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

Parameters:

element - the Dublin Core element

qualifier - the Dublin Core 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).

values - the values to add.

addDC

@Deprecated
public void addDC(String element,
                    String qualifier,
                    String lang,
                    String value)

Deprecated.

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

Parameters:

element - the Dublin Core element

qualifier - the Dublin Core 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.

addMetadata

public void addMetadata(String schema,
               String element,
               String qualifier,
               String lang,
               String[] values)

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.

Parameters:

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.

getAuthoritiesAndConfidences

protected void getAuthoritiesAndConfidences(String fieldKey,
                                String[] values,
                                String[] authorities,
                                int[] confidences,
                                int i)

addMetadata

public void addMetadata(String schema,
               String element,
               String qualifier,
               String lang,
               String[] values,
               String[] authorities,
               int[] confidences)

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

Parameters:

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)

addMetadata

public void addMetadata(String schema,
               String element,
               String qualifier,
               String lang,
               String value)

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

Parameters:

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.

addMetadata

public void addMetadata(String schema,
               String element,
               String qualifier,
               String lang,
               String value,
               String authority,
               int confidence)

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

Parameters:

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)

clearDC

@Deprecated
public void clearDC(String element,
                      String qualifier,
                      String lang)

Deprecated.

Clear Dublin Core 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, idspaceobject.clearDC(DSpaceObject.ANY, DSpaceObject.ANY, DSpaceObject.ANY) will remove all Dublin Core metadata associated with an DSpaceObject.

Parameters:

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.

clearMetadata

public void clearMetadata(String schema,
                 String element,
                 String qualifier,
                 String lang)

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.

Parameters:

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.

getMetadataField

protected MetadataField getMetadataField(Metadatum dcv)
                                  throws SQLException,
                                         AuthorizeException

Throws:

SQLException

AuthorizeException

removeMetadataFromDatabase

protected void removeMetadataFromDatabase()
                                   throws SQLException

Utility method to remove all descriptive metadata associated with the DSpaceObject from the database (regardless of in-memory version)

Throws:

SQLException

getMDValueByField

protected String[] getMDValueByField(String field)

getMDValueByLegacyField

protected String[] getMDValueByLegacyField(String field)