Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PubmedNlm30CitationSchemaFilter Class Reference
Inheritance diagram for PubmedNlm30CitationSchemaFilter:
Nlm30CitationSchemaFilter PersistableFilter Filter DataObject

Public Member Functions

_lookup ($pmid)
 
_search ($searchTerms)
 
 getClassName ()
 
 getEmail ()
 
process (&$citationDescription)
 
 PubmedNlm30CitationSchemaFilter ($filterGroup)
 
- Public Member Functions inherited from Nlm30CitationSchemaFilter
 _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)
 
- 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)
 
 supports (&$input, &$output)
 
 supportsAsInput (&$input)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 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

- Static Public Member Functions inherited from Nlm30CitationSchemaFilter
static _allowedPublicationTypes ()
 
- Static Public Member Functions inherited from PersistableFilter
static tempGroup ($inputType, $outputType)
 
- Static Public Member Functions inherited from Filter
static supportedRuntimeEnvironmentSettings ()
 
- Public Attributes inherited from PersistableFilter
 $_settings = array()
 
- Public Attributes inherited from Filter
 $_errors = array()
 
 $_runtimeEnvironment = false
 
- Public Attributes inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Filter that uses the Pubmed web service to identify a PMID and corresponding meta-data for a given NLM citation.

Definition at line 30 of file PubmedNlm30CitationSchemaFilter.inc.php.

Member Function Documentation

& PubmedNlm30CitationSchemaFilter::_lookup (   $pmid)
& PubmedNlm30CitationSchemaFilter::_search (   $searchTerms)

Searches the given search terms with the pubmed eSearch and returns the found PMIDs as an array.

Parameters
$searchTerms
Returns
array an array with PMIDs

Definition at line 216 of file PubmedNlm30CitationSchemaFilter.inc.php.

References Nlm30CitationSchemaFilter\callWebService(), and getEmail().

Referenced by process().

PubmedNlm30CitationSchemaFilter::getClassName ( )

Return the fully qualified class name of the filter class. This information must be persisted when saving a filter so that the filter can later be reconstructed from the information in the database.

(This must be hard coded by sub-classes for PHP4 compatibility. PHP4 always returns class names lowercase which we cannot tolerate as we need this path to find the class on case sensitive file systems.)

Definition at line 72 of file PubmedNlm30CitationSchemaFilter.inc.php.

PubmedNlm30CitationSchemaFilter::getEmail ( )

Get the email

Returns
string

Definition at line 61 of file PubmedNlm30CitationSchemaFilter.inc.php.

References DataObject\getData().

Referenced by _lookup(), and _search().

& PubmedNlm30CitationSchemaFilter::process ( $citationDescription)
See Also
Filter::process()
Parameters
$citationDescriptionMetadataDescription
Returns
MetadataDescription

Definition at line 85 of file PubmedNlm30CitationSchemaFilter.inc.php.

References _lookup(), and _search().

PubmedNlm30CitationSchemaFilter::PubmedNlm30CitationSchemaFilter (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Definition at line 35 of file PubmedNlm30CitationSchemaFilter.inc.php.

References PersistableFilter\addSetting(), and Filter\setDisplayName().


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