BaseCitationService (sakai-citations-impl 11.0 API)

java.lang.Object
- org.sakaiproject.citation.impl.BaseCitationService

All Implemented Interfaces:

CitationService, EntityProducer

Direct Known Subclasses:

BasicCitationService, DbCitationService
```
public abstract class BaseCitationService
extends Object
implements CitationService
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`BaseCitationService.BasicCitation`
`class`	`BaseCitationService.BasicCitationCollection`
`class`	`BaseCitationService.BasicField`
`protected class`	`BaseCitationService.BasicSchema`
`class`	`BaseCitationService.CitationListCopyAction`
`class`	`BaseCitationService.CitationListCreateAction`
`class`	`BaseCitationService.CitationListDeleteAction`
`class`	`BaseCitationService.CitationListDuplicateAction`
`class`	`BaseCitationService.CitationLocalizer`
`class`	`BaseCitationService.CitationSizeLabeler`
`class`	`BaseCitationService.Counter`
`protected static interface`	`BaseCitationService.Storage`
`class`	`BaseCitationService.UrlWrapper`

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`attemptToMatchSchema`
`protected static List<String>`	`AUTHOR_AS_KEY`
`static Map<String,String>`	`GS_TAGS`
`protected ConfigurationService`	`m_configService` Dependency: CitationsConfigurationService.
`protected ContentHostingService`	`m_contentHostingService` Dependency: ContentHostingService.
`protected String`	`m_defaultSchema`
`protected EntityManager`	`m_entityManager` Dependency: EntityManager.
`protected IdManager`	`m_idManager` Depenedency: IdManager
`protected static AtomicInteger`	`m_nextSerialNumber`
`protected OpenURLServiceImpl`	`m_openURLService` Dependency: OpenURLServiceImpl
`protected String`	`m_relativeAccessPoint`
`protected ResourceTypeRegistry`	`m_resourceTypeRegistry` Dependency: the ResourceTypeRegistry
`protected static Map`	`m_RISNoteFields` Which fields map onto the RIS Notes field?
`protected static Set`	`m_RISSpecialFields` Which fields need special processing for RIS export?
`protected static Map`	`m_RISType` Set up a mapping of our type to RIS 'TY - ' values
`protected static Map`	`m_RISTypeInverse`
`protected ServerConfigurationService`	`m_serverConfigurationService` Dependency: ServerConfigurationService.
`protected BaseCitationService.Storage`	`m_storage` A Storage object for persistent storage.
`static String`	`PROP_TEMPORARY_CITATION_LIST`
`protected static String`	`PROPERTY_DEFAULTVALUE`
`protected static String`	`PROPERTY_DESCRIPTION`
`protected static String`	`PROPERTY_HAS_ABBREVIATION`
`protected static String`	`PROPERTY_HAS_CITATION`
`protected static String`	`PROPERTY_HAS_FIELD`
`protected static String`	`PROPERTY_HAS_NAMESPACE`
`protected static String`	`PROPERTY_HAS_ORDER`
`protected static String`	`PROPERTY_HAS_SCHEMA`
`protected static String`	`PROPERTY_LABEL`
`protected static String`	`PROPERTY_MAXCARDINALITY`
`protected static String`	`PROPERTY_MINCARDINALITY`
`protected static String`	`PROPERTY_NAMESPACE`
`protected static String`	`PROPERTY_REQUIRED`
`protected static String`	`PROPERTY_VALUETYPE`
`static ResourceLoader`	`rb`
`protected static String`	`RIS_DELIM`
`static String`	`SCHEMA_PREFIX`
`protected static List<String>`	`TITLE_AS_KEY`
`protected static List<String>`	`YEAR_AS_KEY`

Fields inherited from interface org.sakaiproject.citation.api.CitationService
APPLICATION_ID, CITATION_LIST_ID, DEFAULT_PAGE_SIZE, HELPER_ID, PROP_ALTERNATE_REFERENCE, PROP_INTRODUCTION, REF_TYPE_EXPORT_RIS_ALL, REF_TYPE_EXPORT_RIS_SEL, REF_TYPE_VIEW_LIST, REFERENCE_ROOT, RIS_FORMAT, SERVICE_NAME, UNKNOWN_TYPE

Constructor Summary

Constructors
Constructor and Description

BaseCitationService()

Constructors
Constructor and Description
`BaseCitationService()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Citation`	`addCitation(HttpServletRequest request)`
`Citation`	`addCitation(String mediatype)`
`CitationCollection`	`addCollection()`
`boolean`	`allowAddCitationList(String contentCollectionId)` Checks permissions to add a CitationList.
`boolean`	`allowRemoveCitationList(String contentResourceId)`
`boolean`	`allowReviseCitationList(String contentResourceId)` Checks permission to revise a CitationList, including permissions to add, remove or revise citations within the CitationList.
`String`	`archive(String siteId, Document doc, Stack stack, String archivePath, List attachments)`
`CitationCollection`	`copyAll(String collectionId)`
`void`	`destroy()` Returns to uninitialized state.
`static String`	`escapeFieldName(String original)`
`protected String`	`getAccessPoint(boolean relative)` Access the partial URL that forms the root of calendar URLs.
`CitationCollection`	`getCollection(String collectionId)`
`Schema`	`getDefaultSchema()`
`Entity`	`getEntity(Reference ref)`
`Collection`	`getEntityAuthzGroups(Reference ref, String userId)`
`String`	`getEntityDescription(Reference ref)`
`ResourceProperties`	`getEntityResourceProperties(Reference ref)`
`String`	`getEntityUrl(Reference ref)`
`HttpAccess`	`getHttpAccess()`
`String`	`getLabel()`
`Set`	`getMultivalued()`
`Set`	`getMultivalued(String type)`
`CitationCollectionOrder`	`getNestedCollection(String citationCollectionId)`
`ResourceTypeRegistry`	`getResourceTypeRegistry()`
`Schema`	`getSchema(String name)`
`List`	`getSchemas()`
`protected Set`	`getSynonyms(String mediatype)`
`Citation`	`getTemporaryCitation()`
`Citation`	`getTemporaryCitation(org.osid.repository.Asset asset)`
`CitationCollection`	`getTemporaryCollection()`
`CitationCollection`	`getUnnestedCitationCollection(String citationCollectionId)`
`Set`	`getValidPropertyNames()`
`void`	`init()`
`protected void`	`initializeSchemas()`
`boolean`	`isAttemptToMatchSchema()`
`boolean`	`isMultivalued(String schemaId, String fieldId)`
`List`	`listSchemas()` Access a list of all schemas that have been defined (other than the "unknown" type).
`String`	`merge(String siteId, Element root, String archivePath, String fromSiteId, Map attachmentNames, Map userIdTrans, Set userListAllowImport)`
`abstract BaseCitationService.Storage`	`newStorage()` Construct a Storage object.
`protected Integer`	`nextSerialNumber()`
`boolean`	`parseEntityReference(String reference, Reference ref)`
`protected void`	`registerResourceType()`
`void`	`removeCollection(CitationCollection edit)`
`void`	`removeLocation(String collectionId, int locationId)`
`void`	`save(Citation citation)`
`void`	`save(CitationCollection collection)`
`void`	`save(CitationCollectionOrder citationCollectionOrder)`
`void`	`save(List<CitationCollectionOrder> citationCollectionOrders, String citationCollectionId)`
`void`	`saveSection(CitationCollectionOrder citationCollectionOrder)`
`void`	`saveSubsection(CitationCollectionOrder citationCollectionOrder)`
`void`	`setAttemptToMatchSchema(boolean attemptToMatchSchema)`
`void`	`setConfigurationService(ConfigurationService service)` Dependency: ConfigurationService.
`void`	`setContentHostingService(ContentHostingService service)` Dependency: ContentHostingService.
`void`	`setEntityManager(EntityManager service)` Dependency: EntityManager.
`void`	`setIdManager(IdManager idManager)`
`void`	`setOpenURLService(OpenURLServiceImpl openURLServiceImpl)`
`void`	`setResourceTypeRegistry(ResourceTypeRegistry registry)` Dependency: inject the ResourceTypeRegistry
`void`	`setServerConfigurationService(ServerConfigurationService service)` Dependency: ServerConfigurationService.
`void`	`updateSection(CitationCollectionOrder citationCollectionOrder)`
`boolean`	`willArchiveMerge()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - attemptToMatchSchema
```
protected boolean attemptToMatchSchema
```
  - AUTHOR_AS_KEY
```
protected static final List<String> AUTHOR_AS_KEY
```
  - YEAR_AS_KEY
```
protected static final List<String> YEAR_AS_KEY
```
  - TITLE_AS_KEY
```
protected static final List<String> TITLE_AS_KEY
```
  - GS_TAGS
```
public static final Map<String,String> GS_TAGS
```
  - rb
```
public static ResourceLoader rb
```
  - PROPERTY_DEFAULTVALUE
```
protected static final String PROPERTY_DEFAULTVALUE
```
    See Also:
    
    Constant Field Values
  - PROPERTY_DESCRIPTION
```
protected static final String PROPERTY_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - PROPERTY_HAS_ABBREVIATION
```
protected static final String PROPERTY_HAS_ABBREVIATION
```
    See Also:
    
    Constant Field Values
  - PROPERTY_HAS_CITATION
```
protected static final String PROPERTY_HAS_CITATION
```
    See Also:
    
    Constant Field Values
  - PROPERTY_HAS_FIELD
```
protected static final String PROPERTY_HAS_FIELD
```
    See Also:
    
    Constant Field Values
  - PROPERTY_HAS_NAMESPACE
```
protected static final String PROPERTY_HAS_NAMESPACE
```
    See Also:
    
    Constant Field Values
  - PROPERTY_HAS_ORDER
```
protected static final String PROPERTY_HAS_ORDER
```
    See Also:
    
    Constant Field Values
  - PROPERTY_HAS_SCHEMA
```
protected static final String PROPERTY_HAS_SCHEMA
```
    See Also:
    
    Constant Field Values
  - PROPERTY_LABEL
```
protected static final String PROPERTY_LABEL
```
    See Also:
    
    Constant Field Values
  - PROPERTY_MAXCARDINALITY
```
protected static final String PROPERTY_MAXCARDINALITY
```
    See Also:
    
    Constant Field Values
  - PROPERTY_MINCARDINALITY
```
protected static final String PROPERTY_MINCARDINALITY
```
    See Also:
    
    Constant Field Values
  - PROPERTY_NAMESPACE
```
protected static final String PROPERTY_NAMESPACE
```
    See Also:
    
    Constant Field Values
  - PROPERTY_REQUIRED
```
protected static final String PROPERTY_REQUIRED
```
    See Also:
    
    Constant Field Values
  - PROPERTY_VALUETYPE
```
protected static final String PROPERTY_VALUETYPE
```
    See Also:
    
    Constant Field Values
  - SCHEMA_PREFIX
```
public static final String SCHEMA_PREFIX
```
    See Also:
    
    Constant Field Values
  - m_nextSerialNumber
```
protected static AtomicInteger m_nextSerialNumber
```
  - RIS_DELIM
```
protected static final String RIS_DELIM
```
    See Also:
    
    Constant Field Values
  - m_RISType
```
protected static final Map m_RISType
```
    Set up a mapping of our type to RIS 'TY - ' values
  - m_RISTypeInverse
```
protected static final Map m_RISTypeInverse
```
  - m_RISNoteFields
```
protected static final Map m_RISNoteFields
```
    Which fields map onto the RIS Notes field? Include a prefix for the data, if necessary.
  - m_RISSpecialFields
```
protected static final Set m_RISSpecialFields
```
    Which fields need special processing for RIS export?
  - m_configService
```
protected ConfigurationService m_configService
```
    Dependency: CitationsConfigurationService.
  - m_serverConfigurationService
```
protected ServerConfigurationService m_serverConfigurationService
```
    Dependency: ServerConfigurationService.
  - m_contentHostingService
```
protected ContentHostingService m_contentHostingService
```
    Dependency: ContentHostingService. This is used for permission checking and the entity methods.
  - m_entityManager
```
protected EntityManager m_entityManager
```
    Dependency: EntityManager.
  - m_idManager
```
protected IdManager m_idManager
```
    Depenedency: IdManager
  - m_openURLService
```
protected OpenURLServiceImpl m_openURLService
```
    Dependency: OpenURLServiceImpl
  - m_defaultSchema
```
protected String m_defaultSchema
```
  - m_storage
```
protected BaseCitationService.Storage m_storage
```
    A Storage object for persistent storage.
  - m_relativeAccessPoint
```
protected String m_relativeAccessPoint
```
  - m_resourceTypeRegistry
```
protected ResourceTypeRegistry m_resourceTypeRegistry
```
    Dependency: the ResourceTypeRegistry
  - PROP_TEMPORARY_CITATION_LIST
```
public static final String PROP_TEMPORARY_CITATION_LIST
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BaseCitationService
```
public BaseCitationService()
```
- Method Detail
  - escapeFieldName
```
public static String escapeFieldName(String original)
```
  - setResourceTypeRegistry
```
public void setResourceTypeRegistry(ResourceTypeRegistry registry)
```
    Dependency: inject the ResourceTypeRegistry
    
    Parameters:
    
    registry -
  - setOpenURLService
```
public void setOpenURLService(OpenURLServiceImpl openURLServiceImpl)
```
  - getResourceTypeRegistry
```
public ResourceTypeRegistry getResourceTypeRegistry()
```
    Returns:
    
    the ResourceTypeRegistry
  - allowAddCitationList
```
public boolean allowAddCitationList(String contentCollectionId)
```
    Checks permissions to add a CitationList. Returns true if the user has permission to add a resource in the collection identified by the parameter.
    
    Specified by:
    
    allowAddCitationList in interface CitationService
    
    Parameters:
    
    contentCollectionId -
    
    Returns:
  - allowReviseCitationList
```
public boolean allowReviseCitationList(String contentResourceId)
```
    Checks permission to revise a CitationList, including permissions to add, remove or revise citations within the CitationList. Returns true if the user has permission to revise the resource identified by the parameter. Also returns true if all of these conditions are met: (1) the user is the creator of the specified resource, (2) the specified resource is a temporary CitationList (as identified by the value of the PROP_TEMPORARY_CITATION_LIST property), and (3) the user has permission to add resources in the collection containing the resource.
    
    Specified by:
    
    allowReviseCitationList in interface CitationService
    
    Parameters:
    
    contentResourceId -
    
    Returns:
  - allowRemoveCitationList
```
public boolean allowRemoveCitationList(String contentResourceId)
```
    Specified by:
    
    allowRemoveCitationList in interface CitationService
    
    Returns:
  - addCitation
```
public Citation addCitation(String mediatype)
```
    Specified by:
    
    addCitation in interface CitationService
  - addCollection
```
public CitationCollection addCollection()
```
    Specified by:
    
    addCollection in interface CitationService
  - archive
```
public String archive(String siteId,
                      Document doc,
                      Stack stack,
                      String archivePath,
                      List attachments)
```
    Specified by:
    
    archive in interface EntityProducer
  - copyAll
```
public CitationCollection copyAll(String collectionId)
```
    Specified by:
    
    copyAll in interface CitationService
  - destroy
```
public void destroy()
```
    Returns to uninitialized state.
  - getAccessPoint
```
protected String getAccessPoint(boolean relative)
```
    Access the partial URL that forms the root of calendar URLs.
    
    Parameters:
    
    relative - if true, form within the access path only (i.e. starting with /content)
    
    Returns:
    
    the partial URL that forms the root of calendar URLs.
  - getCollection
```
public CitationCollection getCollection(String collectionId)
                                 throws IdUnusedException
```
    Specified by:
    
    getCollection in interface CitationService
    
    Throws:
    
    IdUnusedException
  - getDefaultSchema
```
public Schema getDefaultSchema()
```
    Specified by:
    
    getDefaultSchema in interface CitationService
  - getEntity
```
public Entity getEntity(Reference ref)
```
    Specified by:
    
    getEntity in interface EntityProducer
  - getEntityAuthzGroups
```
public Collection getEntityAuthzGroups(Reference ref,
                                       String userId)
```
    Specified by:
    
    getEntityAuthzGroups in interface EntityProducer
  - getEntityDescription
```
public String getEntityDescription(Reference ref)
```
    Specified by:
    
    getEntityDescription in interface EntityProducer
  - getEntityResourceProperties
```
public ResourceProperties getEntityResourceProperties(Reference ref)
```
    Specified by:
    
    getEntityResourceProperties in interface EntityProducer
  - getEntityUrl
```
public String getEntityUrl(Reference ref)
```
    Specified by:
    
    getEntityUrl in interface EntityProducer
  - getHttpAccess
```
public HttpAccess getHttpAccess()
```
    Specified by:
    
    getHttpAccess in interface EntityProducer
  - getLabel
```
public String getLabel()
```
    Specified by:
    
    getLabel in interface EntityProducer
  - getMultivalued
```
public Set getMultivalued()
```
    Returns:
  - getMultivalued
```
public Set getMultivalued(String type)
```
    Returns:
  - getSchema
```
public Schema getSchema(String name)
```
    Specified by:
    
    getSchema in interface CitationService
  - getSchemas
```
public List getSchemas()
```
    Specified by:
    
    getSchemas in interface CitationService
  - getSynonyms
```
protected Set getSynonyms(String mediatype)
```
  - getTemporaryCitation
```
public Citation getTemporaryCitation()
```
    Specified by:
    
    getTemporaryCitation in interface CitationService
  - getTemporaryCitation
```
public Citation getTemporaryCitation(org.osid.repository.Asset asset)
```
    Specified by:
    
    getTemporaryCitation in interface CitationService
  - getTemporaryCollection
```
public CitationCollection getTemporaryCollection()
```
    Specified by:
    
    getTemporaryCollection in interface CitationService
  - getValidPropertyNames
```
public Set getValidPropertyNames()
```
    Specified by:
    
    getValidPropertyNames in interface CitationService
  - init
```
public void init()
```
  - registerResourceType
```
protected void registerResourceType()
```
  - initializeSchemas
```
protected void initializeSchemas()
```
  - isMultivalued
```
public boolean isMultivalued(String schemaId,
                             String fieldId)
```
    Specified by:
    
    isMultivalued in interface CitationService
    
    Parameters:
    
    schemaId -
    
    fieldId -
    
    Returns:
  - listSchemas
```
public List listSchemas()
```
    Access a list of all schemas that have been defined (other than the "unknown" type).
    
    Specified by:
    
    listSchemas in interface CitationService
    
    Returns:
    
    A list of Strings representing the identifiers for known schemas.
  - merge
```
public String merge(String siteId,
                    Element root,
                    String archivePath,
                    String fromSiteId,
                    Map attachmentNames,
                    Map userIdTrans,
                    Set userListAllowImport)
```
    Specified by:
    
    merge in interface EntityProducer
  - newStorage
```
public abstract BaseCitationService.Storage newStorage()
```
    Construct a Storage object.
    
    Returns:
    
    The new storage object.
  - nextSerialNumber
```
protected Integer nextSerialNumber()
```
    Returns:
  - parseEntityReference
```
public boolean parseEntityReference(String reference,
                                    Reference ref)
```
    Specified by:
    
    parseEntityReference in interface EntityProducer
  - removeCollection
```
public void removeCollection(CitationCollection edit)
```
    Specified by:
    
    removeCollection in interface CitationService
  - save
```
public void save(Citation citation)
```
    Specified by:
    
    save in interface CitationService
  - save
```
public void save(CitationCollectionOrder citationCollectionOrder)
```
  - setIdManager
```
public void setIdManager(IdManager idManager)
```
  - save
```
public void save(CitationCollection collection)
```
    Specified by:
    
    save in interface CitationService
  - saveSection
```
public void saveSection(CitationCollectionOrder citationCollectionOrder)
```
    Specified by:
    
    saveSection in interface CitationService
  - saveSubsection
```
public void saveSubsection(CitationCollectionOrder citationCollectionOrder)
```
    Specified by:
    
    saveSubsection in interface CitationService
  - save
```
public void save(List<CitationCollectionOrder> citationCollectionOrders,
                 String citationCollectionId)
```
    Specified by:
    
    save in interface CitationService
  - updateSection
```
public void updateSection(CitationCollectionOrder citationCollectionOrder)
```
    Specified by:
    
    updateSection in interface CitationService
  - getNestedCollection
```
public CitationCollectionOrder getNestedCollection(String citationCollectionId)
```
    Specified by:
    
    getNestedCollection in interface CitationService
  - getUnnestedCitationCollection
```
public CitationCollection getUnnestedCitationCollection(String citationCollectionId)
```
    Specified by:
    
    getUnnestedCitationCollection in interface CitationService
  - removeLocation
```
public void removeLocation(String collectionId,
                           int locationId)
```
    Specified by:
    
    removeLocation in interface CitationService
  - setConfigurationService
```
public void setConfigurationService(ConfigurationService service)
```
    Dependency: ConfigurationService.
    
    Parameters:
    
    service - The ConfigurationService.
  - setContentHostingService
```
public void setContentHostingService(ContentHostingService service)
```
    Dependency: ContentHostingService.
    
    Parameters:
    
    service - The ContentHostingService.
  - setEntityManager
```
public void setEntityManager(EntityManager service)
```
    Dependency: EntityManager.
    
    Parameters:
    
    service - The EntityManager.
  - setServerConfigurationService
```
public void setServerConfigurationService(ServerConfigurationService service)
```
    Dependency: ServerConfigurationService.
    
    Parameters:
    
    service - The ServerConfigurationService.
  - willArchiveMerge
```
public boolean willArchiveMerge()
```
    Specified by:
    
    willArchiveMerge in interface EntityProducer
  - isAttemptToMatchSchema
```
public boolean isAttemptToMatchSchema()
```
    Returns:
    
    the attemptToMatchSchema
  - setAttemptToMatchSchema
```
public void setAttemptToMatchSchema(boolean attemptToMatchSchema)
```
    Parameters:
    
    attemptToMatchSchema - the attemptToMatchSchema to set
  - addCitation
```
public Citation addCitation(HttpServletRequest request)
```
    Specified by:
    
    addCitation in interface CitationService

Class BaseCitationService

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

attemptToMatchSchema

AUTHOR_AS_KEY

YEAR_AS_KEY

TITLE_AS_KEY

GS_TAGS

rb

PROPERTY_DEFAULTVALUE

PROPERTY_DESCRIPTION

PROPERTY_HAS_ABBREVIATION

PROPERTY_HAS_CITATION

PROPERTY_HAS_FIELD

PROPERTY_HAS_NAMESPACE

PROPERTY_HAS_ORDER

PROPERTY_HAS_SCHEMA

PROPERTY_LABEL

PROPERTY_MAXCARDINALITY

PROPERTY_MINCARDINALITY

PROPERTY_NAMESPACE

PROPERTY_REQUIRED

PROPERTY_VALUETYPE

SCHEMA_PREFIX

m_nextSerialNumber

RIS_DELIM

m_RISType

m_RISTypeInverse

m_RISNoteFields

m_RISSpecialFields

m_configService

m_serverConfigurationService

m_contentHostingService

m_entityManager

m_idManager

m_openURLService

m_defaultSchema

m_storage

m_relativeAccessPoint

m_resourceTypeRegistry

PROP_TEMPORARY_CITATION_LIST

Constructor Detail

BaseCitationService

Method Detail

escapeFieldName

setResourceTypeRegistry

setOpenURLService

getResourceTypeRegistry

allowAddCitationList

allowReviseCitationList

allowRemoveCitationList

addCitation

addCollection

archive

copyAll

destroy

getAccessPoint

getCollection

getDefaultSchema

getEntity

getEntityAuthzGroups

getEntityDescription

getEntityResourceProperties

getEntityUrl

getHttpAccess

getLabel

getMultivalued

getMultivalued

getSchema

getSchemas

getSynonyms

getTemporaryCitation

getTemporaryCitation

getTemporaryCollection

getValidPropertyNames