Extractor Interface Reference

Extractors turn a data source into a series of Records. More...

Inheritance diagram for Extractor:

Public Member Functions
	extractFiltered ()
	Iterator taking into account any applicable filtering. More...
	extractAll ()
	Iterator over all canonical source data. More...
Public Member Functions inherited from ConfigurableComponent
	getConfigurationValue (string $optionName)
	Retrieve a configuration value for a named option. More...
	getAllConfigurationValues ()
	Retrieve a list of all available configuration values. More...
Public Member Functions inherited from PropertyList
	getProperties ()
	List the properties available in records generated by this extractor. More...
	getKeyProperties ()
	List the properties which form a unique key for the extracted data. More...

Detailed Description

Extractors turn a data source into a series of Records.

Member Function Documentation

extractFiltered()

extractFiltered

(

)

Iterator taking into account any applicable filtering.

Returns

Record[] One data record from the source being extracted.

Implemented in ExtractorBase.

extractAll()

extractAll

(

)

Iterator over all canonical source data.

Note filtering may be applied here to the raw data, if there are records in the raw source which are not part of the logical source for this extraction process.

Returns

Record[] One data record from the source being extracted.

Exceptions

Implemented in ArrayExtractor.

Referenced by ExtractorBase\extractFiltered(), and CountableExtractorBase\getUncachedCount().