BasicCitationService.BasicCitationStorage (sakai-citations-impl 11.3 API)

java.lang.Object
- org.sakaiproject.citation.impl.BasicCitationService.BasicCitationStorage

All Implemented Interfaces:: BaseCitationService.Storage

Enclosing class:: BasicCitationService

public class BasicCitationService.BasicCitationStorage
extends Object
implements BaseCitationService.Storage

Field Summary

Fields
Modifier and Type Field and Description

protected Map m_citationCollections

protected Map m_citations

protected Map m_collections

protected Map m_schemas

Fields
Modifier and Type	Field and Description
`protected Map`	`m_citationCollections`
`protected Map`	`m_citations`
`protected Map`	`m_collections`
`protected Map`	`m_schemas`

Constructor Summary

Constructors
Constructor and Description

BasicCitationStorage()

Constructors
Constructor and Description
`BasicCitationStorage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Citation`	`addCitation(String mediatype)`
`CitationCollection`	`addCollection(Map attributes, List citations)`
`Schema`	`addSchema(Schema schema)`
`boolean`	`checkCitation(String citationId)`
`boolean`	`checkCollection(String collectionId)`
`boolean`	`checkSchema(String schemaId)`
`void`	`close()` Close.
`CitationCollection`	`copyAll(String collectionId)`
`Citation`	`getCitation(String citationId)`
`CitationCollection`	`getCollection(String collectionId)`
`CitationCollectionOrder`	`getNestedSections(String citationCollectionId)`
`Schema`	`getSchema(String schemaId)`
`Collection`	`getSchemaNames()`
`List`	`getSchemas()`
`CitationCollection`	`getUnnestedCitationCollection(String citationCollectionId)`
`List`	`listSchemas()`
`long`	`mostRecentUpdate(String collectionId)`
`void`	`open()` Open and be ready to read / write.
`void`	`putSchemas(Collection schemas)`
`void`	`removeCitation(Citation edit)`
`void`	`removeCollection(CitationCollection edit)`
`void`	`removeLocation(String collectionId, int locationId)`
`void`	`removeSchema(Schema schema)`
`void`	`saveCitation(Citation edit)`
`void`	`saveCitationCollectionOrder(CitationCollectionOrder citationCollectionOrder)`
`void`	`saveCitationCollectionOrders(List<CitationCollectionOrder> citationCollectionOrders, String citationCollectionId)`
`void`	`saveCollection(CitationCollection collection)`
`void`	`saveSection(CitationCollectionOrder citationCollectionOrder)`
`void`	`saveSubsection(CitationCollectionOrder citationCollectionOrder)`
`void`	`updateCitationCollectionOrder(CitationCollectionOrder citationCollectionOrder)`
`void`	`updateSchema(Schema schema)`
`void`	`updateSchemas(Collection schemas)`

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

- Field Detail
  - m_collections
```
protected Map m_collections
```
  - m_citationCollections
```
protected Map m_citationCollections
```
  - m_citations
```
protected Map m_citations
```
  - m_schemas
```
protected Map m_schemas
```
- Constructor Detail
  - BasicCitationStorage
```
public BasicCitationStorage()
```
- Method Detail
  - open
```
public void open()
```
    Description copied from interface: BaseCitationService.Storage
    
    Open and be ready to read / write.
    
    Specified by:
    
    open in interface BaseCitationService.Storage
  - close
```
public void close()
```
    Description copied from interface: BaseCitationService.Storage
    
    Close.
    
    Specified by:
    
    close in interface BaseCitationService.Storage
  - getCitation
```
public Citation getCitation(String citationId)
```
    Specified by:
    
    getCitation in interface BaseCitationService.Storage
  - getCollection
```
public CitationCollection getCollection(String collectionId)
```
    Specified by:
    
    getCollection in interface BaseCitationService.Storage
  - getSchema
```
public Schema getSchema(String schemaId)
```
    Specified by:
    
    getSchema in interface BaseCitationService.Storage
  - getSchemaNames
```
public Collection getSchemaNames()
```
  - getSchemas
```
public List getSchemas()
```
    Specified by:
    
    getSchemas in interface BaseCitationService.Storage
  - addSchema
```
public Schema addSchema(Schema schema)
```
    Specified by:
    
    addSchema in interface BaseCitationService.Storage
  - putSchemas
```
public void putSchemas(Collection schemas)
```
    Specified by:
    
    putSchemas in interface BaseCitationService.Storage
  - checkCitation
```
public boolean checkCitation(String citationId)
```
    Specified by:
    
    checkCitation in interface BaseCitationService.Storage
  - checkCollection
```
public boolean checkCollection(String collectionId)
```
    Specified by:
    
    checkCollection in interface BaseCitationService.Storage
  - checkSchema
```
public boolean checkSchema(String schemaId)
```
    Specified by:
    
    checkSchema in interface BaseCitationService.Storage
  - listSchemas
```
public List listSchemas()
```
    Specified by:
    
    listSchemas in interface BaseCitationService.Storage
    
    Returns:
  - addCollection
```
public CitationCollection addCollection(Map attributes,
                                        List citations)
```
    Specified by:
    
    addCollection in interface BaseCitationService.Storage
  - removeCitation
```
public void removeCitation(Citation edit)
```
    Specified by:
    
    removeCitation in interface BaseCitationService.Storage
  - removeCollection
```
public void removeCollection(CitationCollection edit)
```
    Specified by:
    
    removeCollection in interface BaseCitationService.Storage
  - updateSchema
```
public void updateSchema(Schema schema)
```
    Specified by:
    
    updateSchema in interface BaseCitationService.Storage
  - updateSchemas
```
public void updateSchemas(Collection schemas)
```
    Specified by:
    
    updateSchemas in interface BaseCitationService.Storage
  - saveCitation
```
public void saveCitation(Citation edit)
```
    Specified by:
    
    saveCitation in interface BaseCitationService.Storage
  - saveCitationCollectionOrder
```
public void saveCitationCollectionOrder(CitationCollectionOrder citationCollectionOrder)
```
    Specified by:
    
    saveCitationCollectionOrder in interface BaseCitationService.Storage
  - saveCollection
```
public void saveCollection(CitationCollection collection)
```
    Specified by:
    
    saveCollection in interface BaseCitationService.Storage
  - saveSection
```
public void saveSection(CitationCollectionOrder citationCollectionOrder)
```
    Specified by:
    
    saveSection in interface BaseCitationService.Storage
  - saveSubsection
```
public void saveSubsection(CitationCollectionOrder citationCollectionOrder)
```
    Specified by:
    
    saveSubsection in interface BaseCitationService.Storage
  - saveCitationCollectionOrders
```
public void saveCitationCollectionOrders(List<CitationCollectionOrder> citationCollectionOrders,
                                         String citationCollectionId)
```
    Specified by:
    
    saveCitationCollectionOrders in interface BaseCitationService.Storage
  - updateCitationCollectionOrder
```
public void updateCitationCollectionOrder(CitationCollectionOrder citationCollectionOrder)
```
    Specified by:
    
    updateCitationCollectionOrder in interface BaseCitationService.Storage
  - getNestedSections
```
public CitationCollectionOrder getNestedSections(String citationCollectionId)
```
    Specified by:
    
    getNestedSections in interface BaseCitationService.Storage
  - getUnnestedCitationCollection
```
public CitationCollection getUnnestedCitationCollection(String citationCollectionId)
```
    Specified by:
    
    getUnnestedCitationCollection in interface BaseCitationService.Storage
  - removeLocation
```
public void removeLocation(String collectionId,
                           int locationId)
```
    Specified by:
    
    removeLocation in interface BaseCitationService.Storage
  - addCitation
```
public Citation addCitation(String mediatype)
```
    Specified by:
    
    addCitation in interface BaseCitationService.Storage
    
    Returns:
  - removeSchema
```
public void removeSchema(Schema schema)
```
    Specified by:
    
    removeSchema in interface BaseCitationService.Storage
  - copyAll
```
public CitationCollection copyAll(String collectionId)
```
    Specified by:
    
    copyAll in interface BaseCitationService.Storage
  - mostRecentUpdate
```
public long mostRecentUpdate(String collectionId)
```
    Specified by:
    
    mostRecentUpdate in interface BaseCitationService.Storage

Class BasicCitationService.BasicCitationStorage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_collections

m_citationCollections

m_citations

m_schemas

Constructor Detail

BasicCitationStorage

Method Detail

open

close

getCitation

getCollection

getSchema

getSchemaNames

getSchemas

addSchema

putSchemas

checkCitation

checkCollection

checkSchema

listSchemas

addCollection

removeCitation

removeCollection

updateSchema

updateSchemas

saveCitation

saveCitationCollectionOrder

saveCollection

saveSection

saveSubsection

saveCitationCollectionOrders

updateCitationCollectionOrder

getNestedSections

getUnnestedCitationCollection

removeLocation

addCitation

removeSchema

copyAll

mostRecentUpdate