PHP Class Nlm30CitationDemultiplexerFilter, pkp-lib

Inheritance: extends Filter
Datei anzeigen Open project: pkp/pkp-lib Class Usage Examples

Public Properties

Property Type Description
$_citationOutputFilter Nlm30CitationSchemaCitationOutputFormatFilter
$_originalDescription the original unfiltered description required for scoring
$_originalRawCitation the original plain text citation required for scoring

Public Methods

Method Description
__construct ( ) Constructor
_filterConfidenceScore ( &$metadataDescription ) : integer Derive a confidence score calculated as the similarity of the original raw citation and the citation text generated from the citation description.
_guessValues ( &$scoredCitations, $scoreThreshold ) : Citation Take an array of citation parse/lookup results and derive a citation with one "best" set of values.
getCitationOutputFilter ( ) : Nlm30CitationSchemaCitationOutputFormatFilter Get the citation output filter
getOriginalDescription ( ) : MetadataDescription Get the original citation description
getOriginalRawCitation ( ) : string Get the original raw citation
process ( &$input ) : Citation
setCitationOutputFilter ( &$citationOutputFilter ) Set the citation output filter
setOriginalDescription ( &$originalDescription ) Set the original citation description
setOriginalRawCitation ( $originalRawCitation ) Set the original raw citation

Method Details

__construct() public method

Constructor
public __construct ( )

_filterConfidenceScore() public method

Derive a confidence score calculated as the similarity of the original raw citation and the citation text generated from the citation description.
public _filterConfidenceScore ( &$metadataDescription ) : integer
$metadataDescription MetadataDescription
return integer filter confidence score

_guessValues() public method

We determine the best values within the citations that have a score above the given threshold. Citations with a score below the threshold will be ignored. For these citations we count the frequency of values per meta-data property. The most frequent value will be chosen as "best" value. If two values have the same frequency then decide based on the score. If this is still ambivalent then return the first of the remaining values.
public _guessValues ( &$scoredCitations, $scoreThreshold ) : Citation
$scoredCitations
$scoreThreshold integer a number between 0 (=no threshold) and 100
return Citation one citation with the "best" values set

getCitationOutputFilter() public method

Get the citation output filter
public getCitationOutputFilter ( ) : Nlm30CitationSchemaCitationOutputFormatFilter
return Nlm30CitationSchemaCitationOutputFormatFilter

getOriginalDescription() public method

Get the original citation description
public getOriginalDescription ( ) : MetadataDescription
return MetadataDescription

getOriginalRawCitation() public method

Get the original raw citation
public getOriginalRawCitation ( ) : string
return string

process() public method

See also: Filter::process()
public process ( &$input ) : Citation
$input array incoming MetadataDescriptions
return Citation

setCitationOutputFilter() public method

Set the citation output filter
public setCitationOutputFilter ( &$citationOutputFilter )
$citationOutputFilter Nlm30CitationSchemaCitationOutputFormatFilter

setOriginalDescription() public method

Set the original citation description
public setOriginalDescription ( &$originalDescription )
$originalDescription MetadataDescription

setOriginalRawCitation() public method

Set the original raw citation
public setOriginalRawCitation ( $originalRawCitation )
$originalRawCitation string

Property Details

$_citationOutputFilter public_oe property

public Nlm30CitationSchemaCitationOutputFormatFilter $_citationOutputFilter
return Nlm30CitationSchemaCitationOutputFormatFilter

$_originalDescription public_oe property

the original unfiltered description required for scoring
public $_originalDescription

$_originalRawCitation public_oe property

the original plain text citation required for scoring
public $_originalRawCitation