Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

skElementObject Class Reference

This object is a container for an element, and exposes an interface to it to Simkin The class implements methods from the Executable interface. More...

#include <skElementObject.h>

Inheritance diagram for skElementObject:

skExecutable skiExecutable skElementExecutable List of all members.

Public Methods

 skElementObject ()
 Default Constructor.

 skElementObject (const skString &location, skElement *elem, bool created)
 Constructor which takes an Element.

 ~skElementObject ()
 Destructor.

int executableType () const
 Returns ELEMENT_TYPE indicating the element is an ElementObject.

int intValue () const
float floatValue () const
bool boolValue () const
Char charValue () const
skString strValue () const
virtual bool setValue (const skString &s, const skString &attribute, const skRValue &return_value)
 sets the value of an item in the element.

virtual bool setValueAt (const skRValue &array_index, const skString &attribute, const skRValue &value)
 Sets a value within the nth element of the element.

virtual bool getValue (const skString &s, const skString &attribute, skRValue &value)
 Retrieves a field from the .

virtual bool getValueAt (const skRValue &array_index, const skString &attribute, skRValue &value)
 Retrieves the nth value from within the element.

virtual bool method (const skString &name, skRValueArray &args, skRValue &ret, skExecutableContext &ctxt)
 this method attempts to execute a method stored in the .

bool equals (skExecutable *o) const
 tests for equality with another object, using the string value

void copyItemsInto (skElement *other)
 Clears the other element and does a deep copy of the children of this node into that one.

virtual void setAddIfNotPresent (bool enable)
 sets the flag controlling whether new elements are created as they are accessed

virtual bool getAddIfNotPresent ()
 this returns the value of the flag controlling whether new elements are created as they are accessed

skElementgetElement ()
 This method returns the Element being held by the object.

void setAttribute (skString name, const skString &value)
 Sets an attribute on this node.

skString getAttribute (const skString &name) const
 This method returns the value of an attribute attached to this element.

skString getLocation () const
 This function returns the location associated with this object (typically a file name).

void setLocation (const skString &location)
 This function sets the location associated with this object (typically a file name).

skExecutableIteratorcreateIterator (const skString &qualifier)
 This function returns an skExecutableIterator object which is used in the for each statement.

skExecutableIteratorcreateIterator ()
 This function returns an skExecutableIterator object which is used in the for each statement.

virtual skString getSource (const skString &location)
 Returns the source code for the given method.

virtual void getInstanceVariables (skRValueTable &table)
 This method returns the instance variables for this object.


Static Public Methods

skString getData (skElement *element)
 retrieves the text data from an element

void setData (skElement *element, const skString &data)
 sets the text data for a node by looking for the first CDATA and TEXT child node

skElementfindChild (skElement *parent, const skString &tagname)
 returns a child element

skElementfindChild (skElement *parent, int index)
 returns the nth child element

skElementfindChild (skElement *parent, const skString &tagname, const skString &attribute, const skString &value)
 returns a child element with the given attribute set to the given value

int countChildren (skElement *parent)
 this method returns the number of element children of the given element


Protected Methods

virtual void setElement (skElement *element, bool created=false)
 This method updates the associated element and clears the parse tree cache.

virtual skElementObject * createElementObject (const skString &location, skElement *element, bool created)
 This method creates a new Element object to wrap an element.

 skElementObject (const skElementObject &)
 Executables can't be copied.

skElementObject & operator= (const skElementObject &)
 Executables can't be copied.


Protected Attributes

skString m_ScriptLocation
 the location that the document came from

skElementm_Element
 the underlying document

skMethodTablem_MethodCache
 a cache used to hold onto parse trees for methods that have already been executed

bool m_AddIfNotPresent
 this variable controls whether new items are added to this element if they are not found, by default it is false, but can be modified using the setAddIfNotPresent() method

bool m_Created
 This value indicates whether or not the Element is "owned" by this object.


Detailed Description

This object is a container for an element, and exposes an interface to it to Simkin The class implements methods from the Executable interface.

The methods getValue, setValue and method all search for matching element tags within the document. Only the first matching tag is used. The class uses the Simkin XML DOM classes.

The class supports the following fields:

The class supports the following methods:


Constructor & Destructor Documentation

skElementObject::skElementObject const skString   location,
skElement   elem,
bool    created
 

Constructor which takes an Element.

Parameters:
location - used to identify the source of the document in error messages
elem - the element to be stored
created - if true, this object will destroy the associated skElement object in its destructor


Member Function Documentation

bool skElementObject::boolValue   const [virtual]
 

Returns:
the value of the element text data as a boolean

Reimplemented from skExecutable.

Char skElementObject::charValue   const [virtual]
 

Returns:
the first character of the element text data

Reimplemented from skExecutable.

void skElementObject::copyItemsInto skElement   other
 

Clears the other element and does a deep copy of the children of this node into that one.

Parameters:
child - the element into which our children will be copied

skElementObject * skElementObject::createElementObject const skString   location,
skElement   element,
bool    created
[protected, virtual]
 

This method creates a new Element object to wrap an element.

Override this for special behaviour in derived classes. In this method, the newly created object inherits this object's m_AddIfNotPresent flag

Parameters:
location the location of this element
element the DOM element to associate with the object

skExecutableIterator * skElementObject::createIterator   [virtual]
 

This function returns an skExecutableIterator object which is used in the for each statement.

It will iterate over *all* children of this element

Reimplemented from skExecutable.

skExecutableIterator * skElementObject::createIterator const skString   qualifier [virtual]
 

This function returns an skExecutableIterator object which is used in the for each statement.

It will iterate over elements with the given tag.

Parameters:
qualifier tag - only elements with this tag will appear in the iteration

Reimplemented from skExecutable.

bool skElementObject::equals skExecutable   o const
 

tests for equality with another object, using the string value

Returns:
true if the data in both elements is the same

int skElementObject::executableType   const [virtual]
 

Returns ELEMENT_TYPE indicating the element is an ElementObject.

Returns:
the type as element

Reimplemented from skExecutable.

skElement * skElementObject::findChild skElement   parent,
const skString   tagname,
const skString   attribute,
const skString   value
[static]
 

returns a child element with the given attribute set to the given value

Parameters:
parent the parent element
tagname the tag name of the element
attribute name of the attribute
value value of the named attribute
Returns:
the first element child of the parent with the matching tag name and attribute value, or null if not found

skElement * skElementObject::findChild skElement   parent,
int    index
[static]
 

returns the nth child element

Parameters:
parent the parent element
index the index of the element
Returns:
the matching element or null if outside the current list ot items

skElement * skElementObject::findChild skElement   parent,
const skString   tagname
[static]
 

returns a child element

Parameters:
parent the parent element
tagname the tag name of the element
Returns:
the first element child of the parent with the matching tag name, or null if not found

float skElementObject::floatValue   const [virtual]
 

Returns:
the value of the element text data as a float

Reimplemented from skExecutable.

bool skElementObject::getAddIfNotPresent   [virtual]
 

this returns the value of the flag controlling whether new elements are created as they are accessed

Returns:
true if the feature is enabled, otherwise false (the default)

skString skElementObject::getAttribute const skString   name const
 

This method returns the value of an attribute attached to this element.

Returns:
the value of the given attribute

skString skElementObject::getData skElement   element [static]
 

retrieves the text data from an element

Parameters:
element 
Returns:
the text from a child node of type CDATA or TEXT

skElement * skElementObject::getElement  
 

This method returns the Element being held by the object.

Returns:
the underlying Element

void skElementObject::getInstanceVariables skRValueTable   table [virtual]
 

This method returns the instance variables for this object.

Parameters:
table a table to filled with references to the instance variables

Reimplemented from skExecutable.

bool skElementObject::getValue const skString   s,
const skString   attribute,
skRValue   value
[virtual]
 

Retrieves a field from the .

The first sub-element matching the tag is found. The value returned is an ElementObject, unless the attrib value is specified. It also supports the following built-in field:

"nodename" - returns the tag name of this element

If the m_AddIfNotPresent flag is true, a new item will be added if one is not already present.

Parameters:
name - the tag name containing the data
attrib - the attribute name to retrieve
value - the RValue to containing the value to be set
Returns:
true if the method was found, false otherwise

Reimplemented from skExecutable.

bool skElementObject::getValueAt const skRValue   array_index,
const skString   attribute,
skRValue   value
[virtual]
 

Retrieves the nth value from within the element.

If the array index falls within the range of the number of children of this element, a new ElementObject encapsulating the child is returned. If the m_AddIfNotPresent flag is true, a new item with the tag name "array_item" will be added if one is not already present

Reimplemented from skExecutable.

int skElementObject::intValue   const [virtual]
 

Returns:
the value of the element text data as an integer

Reimplemented from skExecutable.

bool skElementObject::method const skString   name,
skRValueArray   args,
skRValue   ret,
skExecutableContext   ctxt
[virtual]
 

this method attempts to execute a method stored in the .

It searches for an element whose tag matches the method name and if found passes the text for the tag through to the interpeter.

The method also supports the following methods to Simkin scripts:

  • dump - writes the whole Object out to the tracer (useful for debugging)
  • enumerate([name]) - returns an skElementObjectEnumerator which enumerates over the child elements of this element. If no tag name is passed the enumerator lists all the children. A tag name can be passed to show only children with the matching tag name.
Parameters:
name the name of the method
args an array of arguments to the method
ret the object to receive the result of the method call
context context object to receive errors
Returns:
true if the method was found, false otherwise

Reimplemented from skExecutable.

void skElementObject::setAddIfNotPresent bool    enable [virtual]
 

sets the flag controlling whether new elements are created as they are accessed

Parameters:
enable enables this feature (which by default is disabled)

void skElementObject::setData skElement   element,
const skString   data
[static]
 

sets the text data for a node by looking for the first CDATA and TEXT child node

Parameters:
element the element to be changed
data the data to be set

void skElementObject::setElement skElement   element,
bool    created = false
[protected, virtual]
 

This method updates the associated element and clears the parse tree cache.

Parameters:
elem - the new Element
created - set to true if this object will delete the element at the end

bool skElementObject::setValue const skString   s,
const skString   attribute,
const skRValue   return_value
[virtual]
 

sets the value of an item in the element.

The first sub-element matching the tag is found. If the value passed is an element, it is first copied. If the m_AddIfNotPresent flag is true, a new item will be added if one is not already present

Parameters:
name - the name of the element tag to set (null if it's the overall element)
attribute - the name of the attribute to set (null to set text for the element)
return_value - the RValue to receive the value
Returns:
true if the field was found, false otherwise

Reimplemented from skExecutable.

bool skElementObject::setValueAt const skRValue   array_index,
const skString   attribute,
const skRValue   value
[virtual]
 

Sets a value within the nth element of the element.

If the m_AddIfNotPresent flag is true, a new item with the tag name "array_item" will be added if one is not already present.

Parameters:
array_index - the identifier of the item - this might be a string, integer or any other legal value
attribute - the attribute name to set (may be blank)
value - the value to be set
Returns:
true if the field was changed, false if the field could not be set or found

Reimplemented from skExecutable.

skString skElementObject::strValue   const [virtual]
 

Returns:
the value of the element text data as a string

Reimplemented from skExecutable.


Member Data Documentation

bool skElementObject::m_Created [protected]
 

This value indicates whether or not the Element is "owned" by this object.

If it is, then the element will be deleted when the object is deleted


The documentation for this class was generated from the following files:
Generated on Thu Jan 23 15:25:39 2003 for Simkin by doxygen1.3-rc1