"Znlpi_manager" class

Description

Owner: Znlpi_manager

Operations:

public Znlpi_applyResourceManager ( self in object, parent in object, refSymbol in string ) :
public Znlpi_applyResource ( self in object, parent in object, refSymbol in string ) :
public Znlpi_removeResource ( self in object, parent in object, refSymbol in string ) :
public Znlpi_getTimestamp ( self in object, parent in object, refSymbol in string ) :
public Znlpi_dtmlAgeResource ( self in object, REQUEST in object, PARENTS in list, refSymbol in string ) :
public Znlpi_ageResource ( self in object, parent in object, refSymbol in string ) :
public nlpi_ageAllResource ( self in object, parent in object, refSymbol in string ) :
public Znlpi_actualize ( self in object, REQUEST in object, PARENTS in list, refSymbol in string ) return string :
public Znlpi_actualizeParent ( self in object, REQUEST in object, PARENTS in list, parent in object, refSymbol in string ) :

Associations:

undefined : (0-*) asto Znlpi_resource (1-1) as :

Attributes:

public dictionary Znlpi_resources: Dictionaring containing a Znlpi_resource instance accessed by a specifig refSymbol for each resource. They are provided by python library modules and apply themselves on startup with their reference symbol used to access them.Available resources and dependencies between them are local for one NLPI instance. According to user settings, a resource may dynamically apply or remove itself from the resources list.
public integer Znlpi_resourceSerialNumber: NLPI instance global "current serial number" of the last updated resource.
public string Znlpi_manageOutput: Returned to dtml to produce output. Any resource can write something in it by providing a comment attribte and/or by returning string or list of strings output.
public boolean Znlpi_manageFail: Objects tell the manager that they're failed by this global attribute so that it will not try to countinue.

"Znlpi_applyResourceManager" operation

Description

public Znlpi_applyResourceManager (
      self in object ,
      parent in object ,
      refSymbol in string )

The manager has to initialize its own attributes.

Parameters:

self in object:
parent in object: The main nlpi instance; in Zope a member of the PARENTS list.
refSymbol in string:

"Znlpi_applyResource" operation

Description

public Znlpi_applyResource (
      self in object ,
      parent in object ,
      refSymbol in string )

Apply a registered resource to the NLPI instance. If it is already there leave it as it is.

Applying means to put a copy of the requested resource instance from Znlpi_availableResources to Znlpi_resources.

Parameters:

self in object:
parent in object: The main nlpi instance; in Zope a member of the PARENTS list.
refSymbol in string: The reference symbol for that particular resource.

"Znlpi_removeResource" operation

Description

public Znlpi_removeResource (
      self in object ,
      parent in object ,
      refSymbol in string )

Removes a

1. probably not working/betatest resource or

2. a resource unselected by the user

from the instance and recursively from any needs list.

Parameters:

self in object:
parent in object: The main nlpi instance; in Zope a member of the PARENTS list.
refSymbol in string: The reference symbol for that particular resource.

"Znlpi_getTimestamp" operation

Description

public Znlpi_getTimestamp (
      self in object ,
      parent in object ,
      refSymbol in string )

Gets the current timestamp and serial number from a resource - either the base method of Znlpi_resource or any module specific replacement.

Parameters:

self in object:
parent in object: The main nlpi instance; in Zope a member of the PARENTS list.
refSymbol in string: The reference symbol for that particular resource.

"Znlpi_dtmlAgeResource" operation

Description

public Znlpi_dtmlAgeResource (
      self in object ,
      REQUEST in object ,
      PARENTS in list ,
      refSymbol in string )

Interface to Znlpi_ageResource from dtml (PARENTS instead of parent).

Parameters:

self in object:
REQUEST in object:
PARENTS in list:
refSymbol in string: The reference symbol for that particular resource.

"Znlpi_ageResource" operation

Description

public Znlpi_ageResource (
      self in object ,
      parent in object ,
      refSymbol in string )

Age (=make it old which will trigger its update method when needed the next time) a single resource

This works only with non-file resources (base timestamp method). File resources

are quietly ignored because the only can get aged by overwriting them.

The resource applies first itself to the NLPI instance.

This is needed 1. if it is requested for the first time

and 2. if any dependent resources have added additional

refSymbols in the needs list.

Parameters:

self in object:
parent in object: The main nlpi instance; in Zope a member of the PARENTS list.
refSymbol in string: The reference symbol for that particular resource.

"nlpi_ageAllResource" operation

Description

public nlpi_ageAllResource (
      self in object ,
      parent in object ,
      refSymbol in string )

Age a resource and recursively any dependent resources. The result is a 'force update' of any resources needed.

Parameters:

self in object:
parent in object: The main nlpi instance; in Zope a member of the PARENTS list.
refSymbol in string: The reference symbol for that particular resource.

"Znlpi_actualize" operation

Description

public Znlpi_actualize (
      self in object ,
      REQUEST in object ,
      PARENTS in list ,
      refSymbol in string )
   return string

Entry method for Znlpi_actualizeParent, called by dtml.

If the refSymbol of the resource is prefixed with a '!', any dependent resources are updated, whether they are old or not.

Parameters:

self in object:
REQUEST in object:
PARENTS in list:
refSymbol in string: The reference symbol for that particular resource.

Return value:

If not Null any output produced by the actualize method in html format.

They are sent to the browser after finishing all updates requested.

"Znlpi_actualizeParent" operation

Description

public Znlpi_actualizeParent (
      self in object ,
      REQUEST in object ,
      PARENTS in list ,
      parent in object ,
      refSymbol in string )

Actualizes a given resource.

A resource is old iff a resource in the needs list is younger than the resource itself.

The resource applies first itself to the NLPI instance.

This is needed

1. if it is requested for the first time and

2. if any dependent resources have added additional refSymbols in the needs list.

Dives recursively in any resource in the needs list and actualizes them:

First recursively actualizes any needed resources. They are executed in a left-to-right-manner.

If a (changed) resource makes old another resource on the same level put the former more first, the latter more right in the list so that former will trigger latter.

If it has to be updated a timestamp (incl. serial number) is set with now time.

Any output is appended to Znlpi_manageOutput.

If actualizing a resource fails (e.g. syntax errors in an inform source file) Znlpi_manageFail is set to true.

Parameters:

self in object:
REQUEST in object:
PARENTS in list:
parent in object: The main nlpi instance; in Zope a member of the PARENTS list.
refSymbol in string: The reference symbol for that particular resource.