Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
FilterGroup Class Reference
Inheritance diagram for FilterGroup:
DataObject

Public Member Functions

 FilterGroup ()
 
 getDescription ()
 
 getDisplayName ()
 
 getInputType ()
 
 getOutputType ()
 
 getSymbolic ()
 
 setDescription ($description)
 
 setDisplayName ($displayName)
 
 setInputType ($inputType)
 
 setOutputType ($outputType)
 
 setSymbolic ($symbolic)
 
- 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

- Public Attributes inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Class that represents filter groups.

See Also
PersistableFilter

A filter group is a category of filters that all accept the exact same input and output type and execute semantically very similar tasks (e.g. all citation parsers or all citation output filters).

Distinct filter groups can have define the same input and output types if they do semantically different things (e.g. two XSL operations that both take XML as input and output but do different things).

A transformation can only be part of exactly one filter group. If you find that you want to add the same transformation (same input/output type and same parameterization) to two different filter groups then this indicates that the semantics of the two groups has been defined ambivalently.

The rules for defining filter groups are like this: 1) Describe what the transformation does and not in which context the transformation is being used (e.g. "NLM-3.0 citation-element to plaintext citation output conversion" rather than "Reading tool citation filter"). 2) Make sure that the name is really unique with respect to input type, output type and potential parameterizations of filters in the group. Otherwise you can expect to get name clashes later (e.g. use "NLM-3.0 ... conversion" and not "NLM ... conversion" otherwise you'll get a name clash when NLM 4.0 or 3.1 comes out.

It can be difficult to change filter group names later as we expect community contributions to certain filter groups (e.g. citation parsers).

Definition at line 45 of file FilterGroup.inc.php.

Member Function Documentation

FilterGroup::FilterGroup ( )

Constructor

Definition at line 49 of file FilterGroup.inc.php.

FilterGroup::getDescription ( )

Get the description

Returns
string

Definition at line 100 of file FilterGroup.inc.php.

References DataObject\getData().

FilterGroup::getDisplayName ( )

Get the display name

Returns
string

Definition at line 84 of file FilterGroup.inc.php.

References DataObject\getData().

FilterGroup::getInputType ( )

Get the input type

Returns
string a string representation of a TypeDescription

Definition at line 116 of file FilterGroup.inc.php.

References DataObject\getData().

FilterGroup::getOutputType ( )

Get the output type

Returns
string a string representation of a TypeDescription

Definition at line 132 of file FilterGroup.inc.php.

References DataObject\getData().

FilterGroup::getSymbolic ( )

Get the symbolic name

Returns
string

Definition at line 68 of file FilterGroup.inc.php.

References DataObject\getData().

FilterGroup::setDescription (   $description)

Set the description

Parameters
$descriptionstring

Definition at line 92 of file FilterGroup.inc.php.

References DataObject\setData().

FilterGroup::setDisplayName (   $displayName)

Set the display name

Parameters
$displayNamestring

Definition at line 76 of file FilterGroup.inc.php.

References DataObject\setData().

FilterGroup::setInputType (   $inputType)

Set the input type

Parameters
$inputTypestring a string representation of a TypeDescription

Definition at line 108 of file FilterGroup.inc.php.

References DataObject\setData().

FilterGroup::setOutputType (   $outputType)

Set the output type

Parameters
$outputTypestring a string representation of a TypeDescription

Definition at line 124 of file FilterGroup.inc.php.

References DataObject\setData().

FilterGroup::setSymbolic (   $symbolic)

Set the symbolic name

Parameters
$symbolicstring

Definition at line 60 of file FilterGroup.inc.php.

References DataObject\setData().


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