interface: CitationStyleHandler

public abstract <<interface>> interface: CitationStyleHandler
Author: Galina Stancheva (initial creation) $Author$ (last modification)
Project: Phase: 1.0; Status: Proposed; Version: 1.0, $Revision$; Complexity: 1
Dates: Created: 16.07.2009 15:12:31; Modified: 16.07.2009 15:12:31;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {5DB3F6DF-AA70-4e89-837E-C244DF8A0034}
Interface for retrieving an export file containing and presenting an item list in accordance of the special layout format defined by the citation style. At present CitationStyle handler provides only the following operations: explainStyles and getOutput. Further releases may add some methods for management i.e. create/update/retrieve of particular citation style definitions. Revised by StG: 24.08.2007
@created 26-Jun-2007 18:14:02
 

Goto: Fields, Methods

See also: CitationStyleHandlerBean, ProcessCitationStyles, TestCitationStylesSubstantial, CitationStyleHandlerTest, SearchBean

Appears in: citationmanager

Connections
 
CitationStyleHandler Attributes
Attribute Details
package String
  SERVICE_NAME
Initial: "ejb/de/mpg/escidoc/services/citationmanager/CitationStyleHandler"
Notes: The name to obtain this service.
 
CitationStyleHandler Methods
Operation Details
package
explainStyles():String
Sequential
Tags: throws=IllegalArgumentException,IOException,CitationStyleManagerException
Notes: This method provides XML formatted output of the citation styles (layout formats) with their supported output file formats. The XML formatted output of the citation styles is created in accordance with the explain_styles.xsd.
package
getMimeType(
   String cs,
   String ouf):String
Sequential
Tags: throws=CitationStyleManagerException
Notes: Returns the mime-type for output format of the citation style
@return mime-type, or <code>null</code>, if no <code>mime-type</code> has been found
package
getOutput(
   String citationStyle,
   String ouputFormat,
   String itemList):byte
Sequential
Tags: throws=IOException,JRException,CitationStyleManagerException
Notes: This method provides the formatted output in the desired citation style.
@param outputFormat Identifier (i.e. the name) of the output file format.
package
getOutputFormats(
   String cs):String
Sequential
Tags: throws=CitationStyleManagerException
Notes: The method returns the list of available output formats for citation style <code>cs</code>
@return list of available output formats
package
getStyles():String
Sequential
Tags: throws=CitationStyleManagerException
Notes: The method returns the list of the available citation styles
package
isCitationStyle(
   String cs):boolean
Sequential
Tags: throws=CitationStyleManagerException
Notes: This method returns <code>true</code> if citationStyle is in the list of the citation styles, <code>false</code> otherwise.