org.dspace.license

Class CreativeCommons.MdField

java.lang.Object

org.dspace.license.CreativeCommons.MdField

Enclosing class:

CreativeCommons

public static class CreativeCommons.MdField
extends java.lang.Object

Helper class for using CC-related Metadata fields

Constructor Summary

Constructors

Constructor and Description
CreativeCommons.MdField(java.lang.String fieldName)

Method Summary

Methods

Modifier and Type	Method and Description
void	addItemValue(Item item, java.lang.String value) Adds passed value to the set of values for the field in passed item.
java.lang.String	ccItemValue(Item item) Returns first value that matches Creative Commons 'shibboleth', or null if no matching values.
java.lang.String	keyedItemValue(Item item, java.lang.String key) Returns the value that matches the value mapped to the passed key if any.
void	removeItemValue(Item item, java.lang.String value) Removes the passed value from the set of values for the field in passed item.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreativeCommons.MdField

public CreativeCommons.MdField(java.lang.String fieldName)

Method Detail

ccItemValue

public java.lang.String ccItemValue(Item item)

Returns first value that matches Creative Commons 'shibboleth', or null if no matching values. NB: this method will succeed only for metadata fields holding CC URIs

Parameters:

item - - the item to read

Returns:

value - the first CC-matched value, or null if no such value

keyedItemValue

public java.lang.String keyedItemValue(Item item,
                              java.lang.String key)
                                throws AuthorizeException,
                                       java.io.IOException,
                                       java.sql.SQLException

Returns the value that matches the value mapped to the passed key if any. NB: this only delivers a license name (if present in field) given a license URI

Parameters:

item - - the item to read

key - - the key for desired value

Returns:

value - the value associated with key or null if no such value

Throws:

AuthorizeException

java.io.IOException

java.sql.SQLException

removeItemValue

public void removeItemValue(Item item,
                   java.lang.String value)
                     throws AuthorizeException,
                            java.io.IOException,
                            java.sql.SQLException

Removes the passed value from the set of values for the field in passed item.

Parameters:

item - - the item to update

value - - the value to remove

Throws:

AuthorizeException

java.io.IOException

java.sql.SQLException

addItemValue

public void addItemValue(Item item,
                java.lang.String value)

Adds passed value to the set of values for the field in passed item.

Parameters:

item - - the item to update

value - - the value to add in this field