Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
NativeXmlSubmissionFilter Class Reference
Inheritance diagram for NativeXmlSubmissionFilter:
NativeImportFilter NativeImportExportFilter PersistableFilter Filter DataObject NativeXmlMonographFilter

Public Member Functions

 _getLocalizedSubmissionSetterMappings ()
 
 getClassName ()
 
 getImportFilter ($elementName)
 
 getPluralElementName ()
 
 getPublishedSubmissionDAO ()
 
 getRepresentationExportFilterGroupName ()
 
 getSingularElementName ()
 
 handleChildElement ($n, $submission)
 
 handleElement ($node)
 
 NativeXmlSubmissionFilter ($filterGroup)
 
 parseAuthor ($n, $submission)
 
 parseAuthors ($node, $submission)
 
 parseIdentifier ($element, $submission)
 
 parseSubmissionFile ($n, $submission)
 
 populateObject ($submission, $node)
 
- Public Member Functions inherited from NativeImportFilter
 getPluralElementName ()
 
 getSingularElementName ()
 
 handleElement ($node)
 
 NativeImportFilter ($filterGroup)
 
 parseLocalizedContent ($element)
 
process (&$document)
 
- Public Member Functions inherited from NativeImportExportFilter
 getDeployment ()
 
 NativeImportExportFilter ($filterGroup)
 
 setDeployment ($deployment)
 
- 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 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

Base class that converts a Native XML document to a set of submissions.

Definition at line 18 of file NativeXmlSubmissionFilter.inc.php.

Member Function Documentation

NativeXmlSubmissionFilter::_getLocalizedSubmissionSetterMappings ( )

Get node name to setter function mapping for localized data.

Returns
array

Definition at line 220 of file NativeXmlSubmissionFilter.inc.php.

Referenced by handleChildElement().

NativeXmlSubmissionFilter::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 35 of file NativeXmlSubmissionFilter.inc.php.

NativeXmlSubmissionFilter::getImportFilter (   $elementName)

Get the import filter for a given element.

Parameters
$elementNamestring Name of XML element
Returns
Filter

Definition at line 256 of file NativeXmlSubmissionFilter.inc.php.

Referenced by parseSubmissionFile().

NativeXmlSubmissionFilter::getPluralElementName ( )

Return the plural element name

Returns
string

Definition at line 47 of file NativeXmlSubmissionFilter.inc.php.

References NativeImportExportFilter\getDeployment().

NativeXmlSubmissionFilter::getPublishedSubmissionDAO ( )

Get the published submission DAO for this application.

Returns
DAO

Definition at line 239 of file NativeXmlSubmissionFilter.inc.php.

Referenced by populateObject().

NativeXmlSubmissionFilter::getRepresentationExportFilterGroupName ( )

Get the representation export filter group name

Returns
string

Definition at line 247 of file NativeXmlSubmissionFilter.inc.php.

NativeXmlSubmissionFilter::getSingularElementName ( )

Get the singular element name

Returns
string

Definition at line 56 of file NativeXmlSubmissionFilter.inc.php.

References NativeImportExportFilter\getDeployment().

NativeXmlSubmissionFilter::handleChildElement (   $n,
  $submission 
)

Handle an element whose parent is the submission element.

Parameters
$nDOMElement
$submissionSubmission

Definition at line 120 of file NativeXmlSubmissionFilter.inc.php.

References _getLocalizedSubmissionSetterMappings(), parseAuthors(), parseIdentifier(), NativeImportFilter\parseLocalizedContent(), and parseSubmissionFile().

Referenced by handleElement().

NativeXmlSubmissionFilter::handleElement (   $node)

Handle a singular element import.

Parameters
$nodeDOMElement

Definition at line 65 of file NativeXmlSubmissionFilter.inc.php.

References NativeImportExportFilter\getDeployment(), Application\getSubmissionDAO(), handleChildElement(), and populateObject().

NativeXmlSubmissionFilter::NativeXmlSubmissionFilter (   $filterGroup)

Constructor

Parameters
$filterGroupFilterGroup

Definition at line 23 of file NativeXmlSubmissionFilter.inc.php.

References Filter\setDisplayName().

NativeXmlSubmissionFilter::parseAuthor (   $n,
  $submission 
)

Parse an author and add it to the submission.

Parameters
$nDOMElement
$submissionSubmission

Definition at line 187 of file NativeXmlSubmissionFilter.inc.php.

References DAORegistry\getDAO(), and NativeImportExportFilter\getDeployment().

Referenced by parseAuthors().

NativeXmlSubmissionFilter::parseAuthors (   $node,
  $submission 
)

Parse an authors element

Parameters
$nodeDOMElement
$submissionSubmission

Definition at line 173 of file NativeXmlSubmissionFilter.inc.php.

References parseAuthor().

Referenced by handleChildElement().

NativeXmlSubmissionFilter::parseIdentifier (   $element,
  $submission 
)

Parse an identifier node and set up the submission object accordingly

Parameters
$elementDOMElement
$submissionSubmission

Definition at line 154 of file NativeXmlSubmissionFilter.inc.php.

Referenced by handleChildElement().

NativeXmlSubmissionFilter::parseSubmissionFile (   $n,
  $submission 
)

Parse a submission file and add it to the submission.

Parameters
$nDOMElement
$submissionSubmission

Definition at line 203 of file NativeXmlSubmissionFilter.inc.php.

References NativeImportExportFilter\getDeployment(), and getImportFilter().

Referenced by NativeXmlMonographFilter\handleChildElement(), and handleChildElement().

NativeXmlSubmissionFilter::populateObject (   $submission,
  $node 
)

Populate the submission object from the node

Parameters
$submissionSubmission
$nodeDOMElement
Returns
Submission

Definition at line 99 of file NativeXmlSubmissionFilter.inc.php.

References getPublishedSubmissionDAO(), and Application\getSubmissionDAO().

Referenced by handleElement().


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