Processor Class Reference

Inheritance diagram for Processor:

Collaboration diagram for Processor:

Public Member Functions
_.Library.Status	SetParams (_.Library.String params)
Public Member Functions inherited from Processor
_.Library.String	GetKnownLanguage (_.Library.Integer loc, _.Library.List ref, _.Library.Integer keyid)
_.Library.Status	ProcessListElement (_.Library.Integer loc, _.Library.List ref, _.Library.Integer keyid, _.Library.String metadata, _.Library.Boolean skipped)
_.Library.Status	ProcessVirtualListElement (_.Library.Integer loc, _.Library.List ref)
	Same as <method>ProcessListElement</method>, but for Virtual Sources.
_.Library.Status	SetConverter (_.Library.Integer convId, _.Library.String convParams)
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Member Functions
_.Library.List	GetMetadataKeys (_.Library.String params)

Private Member Functions
_.Library.Status	__FetchSource (_.Library.Integer loc, _.Library.List ref)

Private Attributes
	__Directory
	More...
	__DirectoryId
	More...
	__OpenParms
	More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

This Processor implementation reads data from a filesystem, as listed by the ExpandList method of the <class>iKnow.Source.File.Lister</class>.

Processor parameters:

1. encoding As <class>String</class> - encoding of the files to be read.

Extracted metadata keys:

1. Size
2. DateCreated
3. DateModified

Member Function Documentation

__FetchSource()

_.Library.Status __FetchSource ( _.Library.Integer  loc, _.Library.List  ref  )

private

This is the primary method that will need to be implemented by subclasses. It gets the local ID

of the source being processed (as assigned by the lister) and the Composite Reference in List format. Data read by the Processor should be buffered through calling ..Buffer.BufferString(), which will automatically forward the data to the iKnow Indexing engine or, if configured, a <class>iKnow.Source.Converter</class> object that will in turn push converted data through to the engine.

If this Processor also extracts metadata while reading (as specified in its <method>GetMetadataKeys</method> implementation), it should make sure to invoke <method>SetCurrentMetadataValues</method> at some point in this methods execution.

Reimplemented from Processor.

GetMetadataKeys()

_.Library.List GetMetadataKeys ( _.Library.String  params )

static

Subclasses should override this method to identify those metadata keys that are

calculated or extracted by this Processor implementation and will be registered for every source processed by calling <method>SetCurrentMetadataValues</method> during the <method>FetchSource</method> execution.

Reimplemented from Processor.

SetParams()

_.Library.Status SetParams

(

_.Library.String

params

)

This method stores the Processor parameters in the <property>Params</property> property,

from where they can be referenced in the <method>FetchSource</method> implementation.

NOTE: If this method is overridden by a subclass, it should make sure to either call this method via ##super, or set <property>Params</property> itself.

Reimplemented from Processor.

Member Data Documentation

__Directory

__Directory

private

 

 

__DirectoryId

__DirectoryId

private

 

 

__OpenParms

__OpenParms

private