Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
ParaciteRawCitationNlm30CitationSchemaFilter Class Reference
Inheritance diagram for ParaciteRawCitationNlm30CitationSchemaFilter:
Nlm30CitationSchemaFilter PersistableFilter Filter DataObject

Public Member Functions

 getCitationModule ()
 
 getClassName ()
 
 getSupportedCitationModules ()
 
process ($citationString)
 
- Public Member Functions inherited from Nlm30CitationSchemaFilter
 _allowedPublicationTypes ()
 
 _guessPublicationType (&$metadataArray)
 
_recursivelyTrimPunctuation (&$metadataArray)
 
callWebService ($url, &$params, $returnType=XSL_TRANSFORMER_DOCTYPE_DOM, $method= 'GET')
 
 constructSearchStrings (&$searchTemplates, &$citationDescription)
 
fixPublisherNameAndLocation (&$metadata)
 
 getIsOptional ()
 
getNlm30CitationDescriptionFromMetadataArray (&$metadataArray)
 
 getSupportedPublicationTypes ()
 
 Nlm30CitationSchemaFilter (&$filterGroup, $supportedPublicationTypes=array())
 
postProcessMetadataArray (&$preliminaryNlm30Array)
 
 supports (&$input, &$output)
 
transformWebServiceResults (&$xmlResult, $xslFileName)
 
- Public Member Functions inherited from PersistableFilter
 addSetting (&$setting)
 
 getClassName ()
 
getFilterGroup ()
 
 getInternalSettings ()
 
 getIsTemplate ()
 
 getLocalizedSettingNames ()
 
 getParentFilterId ()
 
getSetting ($settingName)
 
 getSettingNames ()
 
getSettings ()
 
 hasSetting ($settingName)
 
 hasSettings ()
 
 PersistableFilter (&$filterGroup)
 
 setIsTemplate ($isTemplate)
 
 setParentFilterId ($parentFilterId)
 
 tempGroup ($inputType, $outputType)
 
- Public Member Functions inherited from Filter
 addError ($message)
 
 clearErrors ()
 
execute (&$input)
 
 Filter ($inputType, $outputType)
 
 getDisplayName ()
 
 getErrors ()
 
getInputType ()
 
getLastInput ()
 
getLastOutput ()
 
getOutputType ()
 
getRuntimeEnvironment ()
 
 getSeq ()
 
 hasErrors ()
 
 isCompatibleWithRuntimeEnvironment ()
 
process (&$input)
 
 setDisplayName ($displayName)
 
 setRuntimeEnvironment (&$runtimeEnvironment)
 
 setSeq ($seq)
 
 setTransformationType (&$inputType, &$outputType)
 
 supportedRuntimeEnvironmentSettings ()
 
 supports (&$input, &$output)
 
 supportsAsInput (&$input)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
extractMetadata (&$metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
getSupportedExtractionAdapters ()
 
getSupportedInjectionAdapters ()
 
getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata (&$metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
upcastTo (&$targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Paracite parsing filter implementation.

The paracite parsing filter has one parameter: the citation module to be used. This can be one of "Standard", "Citebase" or "Jiao".

If you want to use various modules at the same time then you have to instantiate this parser filter several times with different configuration and chain all instances.

NB: This filter requires perl and CPAN's Biblio::Citation::Parser and Text::Unidecode packages to be installed on the server. It also requires the PHP shell_exec() function to be available which is often disabled in shared hosting environments.

Definition at line 41 of file ParaciteRawCitationNlm30CitationSchemaFilter.inc.php.

Member Function Documentation

ParaciteRawCitationNlm30CitationSchemaFilter::getCitationModule ( )

get the citation module

Returns
string

Definition at line 66 of file ParaciteRawCitationNlm30CitationSchemaFilter.inc.php.

References DataObject\getData().

Referenced by process().

ParaciteRawCitationNlm30CitationSchemaFilter::getClassName ( )
ParaciteRawCitationNlm30CitationSchemaFilter::getSupportedCitationModules ( )

Return supported paracite citation parser modules NB: PHP4 work-around for a public static class member

Returns
array supported citation modules

Definition at line 288 of file ParaciteRawCitationNlm30CitationSchemaFilter.inc.php.

Referenced by ParaciteRawCitationNlm30CitationSchemaFilterTest\testAllCitationsWithThisParser(), and ParaciteRawCitationNlm30CitationSchemaFilterTest\testExecute().


The documentation for this class was generated from the following file: