DataFaucet 1.0 Beta

datafaucet.system
Class duck

WEB-INF.cftags.component
        extended by datafaucet.system.kernel
            extended by datafaucet.system.duck
Direct Known Subclasses:
broadcaster , datasource , gateway , schemaexport

public class duck
extends kernel

basic accessor / mutator functionality


Constructor Summary
init()
          initializes the CFC with required properties, etc.
 
Method Summary
 any addObserver(string property, any observer)
          adds an observer to the current CFC to alert another CFC or when a property of the CFC is alterred
private struct getObservers()
 any getProperties()
          returns all properties from a cfc in a structure
private any getProperty(string propertyname)
          gets properties from the current object - all custom get methods should set properties with this method - overwriting this method (in addition to setProperty) allows you to change the location of all properties stored for the component
private any getPropertylist()
          returns the names of all properties from a cfc as a list
 any getValue(string propertyname)
          returns a property or variable from the component -- uses a private method if it exists for any property
private struct identifyAccessorOrMutator(string MissingMethodName, struct MissingMethodArguments)
 any observe(string propertyname, [any propertyvalue=''], [boolean overwrite='true'], any instance)
          handles events returned by watching another components properties
 any onMissingMethod(string MissingMethodName, struct MissingMethodArguments)
          Handles missing method exceptions.
private any raiseMissingMethodException(string MissingMethodName)
 any reset()
          clears all properties from the object
 any setProperties(any properties, boolean overwrite='true', [numeric index='1'])
          sets all properties for a cfc simultaneously using the setValue method to preserve custom setValue functions and observer functionality
private void setProperty(string propertyname, any propertyvalue, [boolean overwrite='true'])
          sets properties in the current object - all custom set methods should set properties with this method - overwriting this method (in addition to getProperty) allows you to change the location of all properties stored for the component
 any setValue(string propertyname, any propertyvalue, [boolean overwrite='true'])
          sets a property or variable in the component -- uses a private method if it exists for any property
 
Methods inherited from class datafaucet.system.kernel
arg, componentExists, getDataFaucet, getFaucetObject, getFile, getFileModified, getObject, getPlumbing, getTransaction, getTransactionManager, newTransaction, parseDate, setTransaction
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init()
initializes the CFC with required properties, etc.

Method Detail

addObserver

public any addObserver(string property, any observer)
adds an observer to the current CFC to alert another CFC or when a property of the CFC is alterred

Parameters:
property - the property to which interest should be registered
observer - the object interested in the property - the observer object must have a corresponding observe_[property] method

getObservers

private struct getObservers()


getProperties

public any getProperties()
returns all properties from a cfc in a structure


getProperty

private any getProperty(string propertyname)
gets properties from the current object - all custom get methods should set properties with this method - overwriting this method (in addition to setProperty) allows you to change the location of all properties stored for the component

Parameters:
propertyname

getPropertylist

private any getPropertylist()
returns the names of all properties from a cfc as a list


getValue

public any getValue(string propertyname)
returns a property or variable from the component -- uses a private method if it exists for any property

Parameters:
propertyname - the name of the property value to return

identifyAccessorOrMutator

private struct identifyAccessorOrMutator(string MissingMethodName, struct MissingMethodArguments)

Parameters:
MissingMethodName - The name of the missing method.
MissingMethodArguments

observe

public any observe(string propertyname, [any propertyvalue=''], [boolean overwrite='true'], any instance)
handles events returned by watching another components properties

Parameters:
propertyname
propertyvalue
overwrite
instance

onMissingMethod

public any onMissingMethod(string MissingMethodName, struct MissingMethodArguments)
Handles missing method exceptions.

Parameters:
MissingMethodName - The name of the missing method.
MissingMethodArguments - The arguments that were passed to the missing method. This might be a named argument set or a numerically indexed set.

raiseMissingMethodException

private any raiseMissingMethodException(string MissingMethodName)

Parameters:
MissingMethodName - The name of the missing method.

reset

public any reset()
clears all properties from the object


setProperties

public any setProperties(any properties, boolean overwrite='true', [numeric index='1'])
sets all properties for a cfc simultaneously using the setValue method to preserve custom setValue functions and observer functionality

Parameters:
properties - a structure or query containing keys which match the keys of the property structure
overwrite - when false the component's existing properties will be preserved
index - if the properties argument is a query the index argument can be used to determine what row of the query is used to populate the object

setProperty

private void setProperty(string propertyname, any propertyvalue, [boolean overwrite='true'])
sets properties in the current object - all custom set methods should set properties with this method - overwriting this method (in addition to getProperty) allows you to change the location of all properties stored for the component

Parameters:
propertyname - the name of the property to set
propertyvalue - the value to set for the property
overwrite - if false an existing property value will be preserved

setValue

public any setValue(string propertyname, any propertyvalue, [boolean overwrite='true'])
sets a property or variable in the component -- uses a private method if it exists for any property

Parameters:
propertyname - the name of the property to set
propertyvalue - the value to set for the property named
overwrite - determines if the provided value should overwrite an existing property

DataFaucet 1.0 Beta