org.sakaiproject.citation.impl

Class BaseCitationService.BasicCitationCollection

java.lang.Object

org.sakaiproject.citation.impl.BaseCitationService.BasicCitationCollection

All Implemented Interfaces:

CitationCollection, Entity

Enclosing class:

BaseCitationService

public class BaseCitationService.BasicCitationCollection
extends Object
implements CitationCollection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BaseCitationService.BasicCitationCollection.AuthorComparator
class	BaseCitationService.BasicCitationCollection.BasicIterator
class	BaseCitationService.BasicCitationCollection.MultipleKeyComparator
class	BaseCitationService.BasicCitationCollection.PositionComparator
class	BaseCitationService.BasicCitationCollection.TitleComparator
class	BaseCitationService.BasicCitationCollection.YearComparator

Field Summary

Fields

Modifier and Type	Field and Description
protected Comparator	DEFAULT_COMPARATOR
protected boolean	m_ascending
protected Map<String,Citation>	m_citations
protected Comparator	m_comparator
protected String	m_description
protected String	m_id
protected long	m_mostRecentUpdate
protected ActiveSearch	m_mySearch
protected List<CitationCollectionOrder>	m_nestedCitationCollectionOrders
protected SortedSet<String>	m_order
protected int	m_pageSize
protected Integer	m_serialNumber
protected String	m_sortOrder
protected boolean	m_temporary
protected String	m_title

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

SORT_BY_AUTHOR, SORT_BY_DEFAULT_ORDER, SORT_BY_POSITION, SORT_BY_TITLE, SORT_BY_UUID, SORT_BY_YEAR

Fields inherited from interface org.sakaiproject.entity.api.Entity

SEPARATOR

Constructor Summary

Constructors

Constructor and Description
BasicCitationCollection()
BasicCitationCollection(boolean temporary)
BasicCitationCollection(Map attributes, List citations)
BasicCitationCollection(String collectionId)

Method Summary

Modifier and Type	Method and Description
void	add(Citation citation)
void	addAll(CitationCollection other)
protected void	checkForUpdates()
void	clear()
boolean	contains(Citation citation)
protected void	copy(BaseCitationService.BasicCitationCollection other)
void	exportRis(StringBuilder buffer, List<String> citationIds)
protected String	getAlternateReferenceRoot(String rootProperty) Compute an alternate root for a reference, based on the root property.
Citation	getCitation(String citationId)
List	getCitations()
CitationCollection	getCitations(Comparator c)
CitationCollection	getCitations(Comparator c, Filter f)
CitationCollection	getCitations(Filter f)
CitationCollection	getCitations(Map properties)
String	getDescription()
String	getId()
Date	getLastModifiedDate()
List<CitationCollectionOrder>	getNestedCitationCollectionOrders()
ResourceProperties	getProperties()
String	getReference()
String	getReference(String rootProperty)
String	getSaveUrl()
String	getSort()
String	getTitle()
String	getUrl()
String	getUrl(String rootProperty)
boolean	isEmpty()
CitationIterator	iterator()
boolean	remove(Citation item)
void	saveCitation(Citation citation)
void	saveCitationCollectionOrder(CitationCollectionOrder citationCollectionOrder)
protected void	set(BaseCitationService.BasicCitationCollection other, boolean isTemporary) copy
void	setNestedCitationCollectionOrders(List<CitationCollectionOrder> m_nestedCitationCollectionOrders)
void	setSort(Comparator comparator)
void	setSort(String sortBy, boolean ascending)
int	size()
String	toString()
Element	toXml(Document doc, Stack stack)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COMPARATOR

protected final Comparator DEFAULT_COMPARATOR

m_citations

protected Map<String,Citation> m_citations

m_nestedCitationCollectionOrders

protected List<CitationCollectionOrder> m_nestedCitationCollectionOrders

m_comparator

protected Comparator m_comparator

m_sortOrder

protected String m_sortOrder

m_order

protected SortedSet<String> m_order

m_pageSize

protected int m_pageSize

m_description

protected String m_description

m_id

protected String m_id

m_title

protected String m_title

m_temporary

protected boolean m_temporary

m_serialNumber

protected Integer m_serialNumber

m_mySearch

protected ActiveSearch m_mySearch

m_ascending

protected boolean m_ascending

m_mostRecentUpdate

protected long m_mostRecentUpdate

Constructor Detail

BasicCitationCollection

public BasicCitationCollection()

BasicCitationCollection

public BasicCitationCollection(boolean temporary)

Parameters:

b -

BasicCitationCollection

public BasicCitationCollection(Map attributes,
                               List citations)

BasicCitationCollection

public BasicCitationCollection(String collectionId)

Parameters:

collectionId -

Method Detail

add

public void add(Citation citation)

Specified by:

add in interface CitationCollection

addAll

public void addAll(CitationCollection other)

Specified by:

addAll in interface CitationCollection

clear

public void clear()

Specified by:

clear in interface CitationCollection

contains

public boolean contains(Citation citation)

Specified by:

contains in interface CitationCollection

copy

protected void copy(BaseCitationService.BasicCitationCollection other)

exportRis

public void exportRis(StringBuilder buffer,
                      List<String> citationIds)
               throws IOException

Specified by:

exportRis in interface CitationCollection

Throws:

IOException

getAlternateReferenceRoot

protected String getAlternateReferenceRoot(String rootProperty)

Compute an alternate root for a reference, based on the root property.

Parameters:

rootProperty - The property name.

Returns:

The alternate root, or "" if there is none.

getCitation

public Citation getCitation(String citationId)
                     throws IdUnusedException

Specified by:

getCitation in interface CitationCollection

Throws:

IdUnusedException

getCitations

public List getCitations()

Specified by:

getCitations in interface CitationCollection

getNestedCitationCollectionOrders

public List<CitationCollectionOrder> getNestedCitationCollectionOrders()

setNestedCitationCollectionOrders

public void setNestedCitationCollectionOrders(List<CitationCollectionOrder> m_nestedCitationCollectionOrders)

getCitations

public CitationCollection getCitations(Comparator c)

getCitations

public CitationCollection getCitations(Comparator c,
                                       Filter f)

getCitations

public CitationCollection getCitations(Filter f)

getCitations

public CitationCollection getCitations(Map properties)

getDescription

public String getDescription()

Specified by:

getDescription in interface CitationCollection

getId

public String getId()

Specified by:

getId in interface CitationCollection

Specified by:

getId in interface Entity

getLastModifiedDate

public Date getLastModifiedDate()

Specified by:

getLastModifiedDate in interface CitationCollection

getProperties

public ResourceProperties getProperties()

Specified by:

getProperties in interface Entity

getReference

public String getReference()

Specified by:

getReference in interface Entity

getReference

public String getReference(String rootProperty)

Specified by:

getReference in interface Entity

getSort

public String getSort()

Specified by:

getSort in interface CitationCollection

getSaveUrl

public String getSaveUrl()

Specified by:

getSaveUrl in interface CitationCollection

getTitle

public String getTitle()

Specified by:

getTitle in interface CitationCollection

getUrl

public String getUrl()

Specified by:

getUrl in interface Entity

getUrl

public String getUrl(String rootProperty)

Specified by:

getUrl in interface Entity

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface CitationCollection

iterator

public CitationIterator iterator()

Specified by:

iterator in interface CitationCollection

remove

public boolean remove(Citation item)

Specified by:

remove in interface CitationCollection

saveCitation

public void saveCitation(Citation citation)

Specified by:

saveCitation in interface CitationCollection

saveCitationCollectionOrder

public void saveCitationCollectionOrder(CitationCollectionOrder citationCollectionOrder)

setSort

public void setSort(Comparator comparator)

Specified by:

setSort in interface CitationCollection

Parameters:

comparator -

setSort

public void setSort(String sortBy,
                    boolean ascending)

Specified by:

setSort in interface CitationCollection

Parameters:

sortBy -

ascending -

size

public int size()

Specified by:

size in interface CitationCollection

toString

public String toString()

Overrides:

toString in class Object

toXml

public Element toXml(Document doc,
                     Stack stack)

Specified by:

toXml in interface Entity

checkForUpdates

protected void checkForUpdates()

set

protected void set(BaseCitationService.BasicCitationCollection other,
                   boolean isTemporary)

copy

Parameters:

other -