org.sakaiproject.citation.impl

Class BaseCitationService.BasicCitation

java.lang.Object

org.sakaiproject.citation.impl.BaseCitationService.BasicCitation

All Implemented Interfaces:

Citation

Enclosing class:

BaseCitationService

public class BaseCitationService.BasicCitation
extends Object
implements Citation

Field Summary

Fields

Modifier and Type	Field and Description
protected Map	m_citationProperties
protected String	m_citationUrl
protected String	m_fullTextUrl
protected String	m_id
protected String	m_imageUrl
protected boolean	m_isAdded
protected int	m_position
protected String	m_preferredUrl
protected Schema	m_schema
protected String	m_searchSourceUrl
protected Integer	m_serialNumber
protected boolean	m_temporary
protected Map	m_urls
protected static String	OPENURL_BOOK_FORMAT
protected static String	OPENURL_CONTEXT_FORMAT
protected static String	OPENURL_JOURNAL_FORMAT
protected static String	OPENURL_VERSION

Fields inherited from interface org.sakaiproject.citation.api.Citation

ADD_PREFIX_TEXT, OMIT_PREFIX_TEXT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicCitation() Constructs a temporary citation.
protected	BasicCitation(org.osid.repository.Asset asset) Constructs a temporary citation based on an asset.
	BasicCitation(BaseCitationService.BasicCitation other)
	BasicCitation(String mediatype) Construct a citation not marked as temporary of a particular type.
	BasicCitation(String citationId, Schema schema)
	BasicCitation(String citationId, String mediatype) Construct a citation not marked as temporary of a particular type with a particular id.

Method Summary

Modifier and Type	Method and Description
String	addCustomUrl(String label, String url)
String	addCustomUrl(String label, String url, String prefixRequest)
boolean	addPrefixToUrl(String id) Add prefix text to this URL?
void	addPropertyValue(String name, Object value)
void	copy(Citation citation)
void	exportRis(StringBuilder buffer)
void	exportRisField(String rislabel, List propvalues, StringBuilder buffer, String prefix)
void	exportRisField(String rislabel, Object val, StringBuilder buffer)
void	exportRisField(String rislabel, Object val, StringBuilder buffer, String prefix)
void	exportRisField(String rislabel, String value, StringBuilder buffer)
void	exportRisField(String rislabel, String value, StringBuilder buffer, String prefix)
String	getAbstract()
Map	getCitationProperties()
Object	getCitationProperty(String name)
Object	getCitationProperty(String name, boolean needSingleValue)
String	getCreator()
String	getCustomUrl(String id) Fetch a custom (direct) URL by ID.
List	getCustomUrlIds()
String	getCustomUrlLabel(String id)
String	getDisplayName()
String	getFirstAuthor()
String	getId()
String	getOpenurl()
String	getOpenurlParameters()
int	getPosition() This only makes sense, and will only be set, in the context of a collection.
String	getPreferredUrlId()
String	getPrimaryUrl() Get the primary URL for this resource Normally, this is an OpenURL created from citation properties, but if either the Repository OSID or the user has designated a preferred URL, we'll use it instead.
Schema	getSchema()
String	getSource()
String	getSubjectString()
String	getUnprefixedCustomUrl(String id) Fetch a custom (direct) URL by ID.
String	getUrlPrefix() Fetch the configured URL prefix string.
String	getYear()
boolean	hasCitationProperty(String fieldId)
boolean	hasCustomUrls()
boolean	hasPreferredUrl()
boolean	hasPropertyValue(String fieldId)
void	importFromRis(InputStream ris)
boolean	importFromRisList(List risImportList)
boolean	isAdded()
protected boolean	isCurrentlyMultivalued(String fieldId) Checks if the field is currently multivalued.
boolean	isMultivalued(String fieldId)
protected boolean	isSchemaLimited(String fieldId)
protected boolean	isSchemaMultivalued(String fieldId) Should the field be limited to a single value.
boolean	isTemporary()
List	listCitationProperties()
protected void	matchSchema()
void	setAdded(boolean added)
void	setCitationProperty(String name, Object value)
protected void	setDefaults()
void	setDisplayName(String name)
void	setPosition(int position) This only makes sense, and will only be set, in the context of a collection.
void	setPreferredUrl(String urlid)
void	setSchema(Schema schema)
protected void	setType(String mediatype)
String	toString()
void	updateCitationProperty(String name, List values)
void	updateCustomUrl(String urlid, String label, String url, String prefixRequest)

Methods inherited from class java.lang.Object

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

Field Detail

OPENURL_VERSION

protected static final String OPENURL_VERSION

See Also:

Constant Field Values

OPENURL_CONTEXT_FORMAT

protected static final String OPENURL_CONTEXT_FORMAT

See Also:

Constant Field Values

OPENURL_JOURNAL_FORMAT

protected static final String OPENURL_JOURNAL_FORMAT

See Also:

Constant Field Values

OPENURL_BOOK_FORMAT

protected static final String OPENURL_BOOK_FORMAT

See Also:

Constant Field Values

m_citationProperties

protected Map m_citationProperties

m_urls

protected Map m_urls

m_citationUrl

protected String m_citationUrl

m_fullTextUrl

protected String m_fullTextUrl

m_id

protected String m_id

m_imageUrl

protected String m_imageUrl

m_position

protected int m_position

m_schema

protected Schema m_schema

m_searchSourceUrl

protected String m_searchSourceUrl

m_serialNumber

protected Integer m_serialNumber

m_temporary

protected boolean m_temporary

m_isAdded

protected boolean m_isAdded

m_preferredUrl

protected String m_preferredUrl

Constructor Detail

BasicCitation

protected BasicCitation()

Constructs a temporary citation.

BasicCitation

protected BasicCitation(org.osid.repository.Asset asset)

Constructs a temporary citation based on an asset.

Parameters:

asset -

BasicCitation

public BasicCitation(BaseCitationService.BasicCitation other)

Parameters:

other -

BasicCitation

public BasicCitation(String mediatype)

Construct a citation not marked as temporary of a particular type.

Parameters:

mediatype -

BasicCitation

public BasicCitation(String citationId,
                     Schema schema)

BasicCitation

public BasicCitation(String citationId,
                     String mediatype)

Construct a citation not marked as temporary of a particular type with a particular id.

Parameters:

citationId -

mediatype -

Method Detail

matchSchema

protected void matchSchema()

addCustomUrl

public String addCustomUrl(String label,
                           String url)

Specified by:

addCustomUrl in interface Citation

addCustomUrl

public String addCustomUrl(String label,
                           String url,
                           String prefixRequest)

Specified by:

addCustomUrl in interface Citation

updateCustomUrl

public void updateCustomUrl(String urlid,
                            String label,
                            String url,
                            String prefixRequest)

Specified by:

updateCustomUrl in interface Citation

addPropertyValue

public void addPropertyValue(String name,
                             Object value)

Specified by:

addPropertyValue in interface Citation

copy

public void copy(Citation citation)

Parameters:

citation -

exportRisField

public void exportRisField(String rislabel,
                           String value,
                           StringBuilder buffer,
                           String prefix)

exportRisField

public void exportRisField(String rislabel,
                           String value,
                           StringBuilder buffer)

exportRisField

public void exportRisField(String rislabel,
                           List propvalues,
                           StringBuilder buffer,
                           String prefix)

exportRisField

public void exportRisField(String rislabel,
                           Object val,
                           StringBuilder buffer,
                           String prefix)

exportRisField

public void exportRisField(String rislabel,
                           Object val,
                           StringBuilder buffer)

exportRis

public void exportRis(StringBuilder buffer)
               throws IOException

Specified by:

exportRis in interface Citation

Throws:

IOException

getCitationProperties

public Map getCitationProperties()

Specified by:

getCitationProperties in interface Citation

getCitationProperty

public Object getCitationProperty(String name)

Specified by:

getCitationProperty in interface Citation

getCitationProperty

public Object getCitationProperty(String name,
                                  boolean needSingleValue)

Specified by:

getCitationProperty in interface Citation

getCreator

public String getCreator()

Specified by:

getCreator in interface Citation

getCustomUrl

public String getCustomUrl(String id)
                    throws IdUnusedException

Fetch a custom (direct) URL by ID.

Specified by:

getCustomUrl in interface Citation

Throws:

IdUnusedException

See Also:

Citation.getCustomUrl(java.lang.String)

getUnprefixedCustomUrl

public String getUnprefixedCustomUrl(String id)
                              throws IdUnusedException

Fetch a custom (direct) URL by ID. The URL prefix (if applicable) is not added.

Specified by:

getUnprefixedCustomUrl in interface Citation

Throws:

IdUnusedException

See Also:

Citation.getUnprefixedCustomUrl(java.lang.String)

getUrlPrefix

public String getUrlPrefix()

Fetch the configured URL prefix string.

Specified by:

getUrlPrefix in interface Citation

Returns:

The prefix (null if none)

See Also:

Citation.getUnprefixedCustomUrl(java.lang.String)

addPrefixToUrl

public boolean addPrefixToUrl(String id)
                       throws IdUnusedException

Add prefix text to this URL?

Specified by:

addPrefixToUrl in interface Citation

Returns:

true If the URL should get the prefix

Throws:

IdUnusedException

getCustomUrlIds

public List getCustomUrlIds()

Specified by:

getCustomUrlIds in interface Citation

getCustomUrlLabel

public String getCustomUrlLabel(String id)
                         throws IdUnusedException

Specified by:

getCustomUrlLabel in interface Citation

Throws:

IdUnusedException

getYear

public String getYear()

Specified by:

getYear in interface Citation

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Citation

getPrimaryUrl

public String getPrimaryUrl()

Get the primary URL for this resource Normally, this is an OpenURL created from citation properties, but if either the Repository OSID or the user has designated a preferred URL, we'll use it instead.

Specified by:

getPrimaryUrl in interface Citation

Returns:

The primary URL (null if none available)

getFirstAuthor

public String getFirstAuthor()

Specified by:

getFirstAuthor in interface Citation

getId

public String getId()

Specified by:

getId in interface Citation

getOpenurl

public String getOpenurl()

Specified by:

getOpenurl in interface Citation

getOpenurlParameters

public String getOpenurlParameters()

Specified by:

getOpenurlParameters in interface Citation

getPosition

public int getPosition()

This only makes sense, and will only be set, in the context of a collection.

Specified by:

getPosition in interface Citation

getSchema

public Schema getSchema()

Specified by:

getSchema in interface Citation

getSource

public String getSource()

Specified by:

getSource in interface Citation

getAbstract

public String getAbstract()

getSubjectString

public String getSubjectString()

hasCustomUrls

public boolean hasCustomUrls()

Specified by:

hasCustomUrls in interface Citation

hasPropertyValue

public boolean hasPropertyValue(String fieldId)

Specified by:

hasPropertyValue in interface Citation

importFromRis

public void importFromRis(InputStream ris)
                   throws IOException

Specified by:

importFromRis in interface Citation

Throws:

IOException

importFromRisList

public boolean importFromRisList(List risImportList)

Specified by:

importFromRisList in interface Citation

isAdded

public boolean isAdded()

Specified by:

isAdded in interface Citation

isMultivalued

public boolean isMultivalued(String fieldId)

Specified by:

isMultivalued in interface Citation

isCurrentlyMultivalued

protected boolean isCurrentlyMultivalued(String fieldId)

Checks if the field is currently multivalued. This doesn't consult the schema, but looks what's actually stored.

Parameters:

fieldId - Field name.

Returns:

true if the field is multivalued.

isSchemaMultivalued

protected boolean isSchemaMultivalued(String fieldId)

Should the field be limited to a single value.

Parameters:

fieldId -

Returns:

isTemporary

public boolean isTemporary()

Returns:

isSchemaLimited

protected boolean isSchemaLimited(String fieldId)

listCitationProperties

public List listCitationProperties()

Specified by:

listCitationProperties in interface Citation

setAdded

public void setAdded(boolean added)

Specified by:

setAdded in interface Citation

setCitationProperty

public void setCitationProperty(String name,
                                Object value)

Specified by:

setCitationProperty in interface Citation

hasCitationProperty

public boolean hasCitationProperty(String fieldId)

Specified by:

hasCitationProperty in interface Citation

setDefaults

protected void setDefaults()

setDisplayName

public void setDisplayName(String name)

Specified by:

setDisplayName in interface Citation

setPosition

public void setPosition(int position)

This only makes sense, and will only be set, in the context of a collection.

Specified by:

setPosition in interface Citation

setSchema

public void setSchema(Schema schema)

Specified by:

setSchema in interface Citation

setType

protected void setType(String mediatype)

toString

public String toString()

Overrides:

toString in class Object

updateCitationProperty

public void updateCitationProperty(String name,
                                   List values)

Specified by:

updateCitationProperty in interface Citation

getPreferredUrlId

public String getPreferredUrlId()

Specified by:

getPreferredUrlId in interface Citation

hasPreferredUrl

public boolean hasPreferredUrl()

Specified by:

hasPreferredUrl in interface Citation

setPreferredUrl

public void setPreferredUrl(String urlid)

Specified by:

setPreferredUrl in interface Citation