railo.runtime
Class SuperComponent

java.lang.Object
  extended by railo.runtime.component.MemberSupport
      extended by railo.runtime.SuperComponent
All Implemented Interfaces:
Serializable, Cloneable, Map, CFObject, Component, Member, ComponentPro, Dumpable, Castable, Collection, Duplicable, ForEachIteratorable, Iteratorable, Objects, Sizeable, Struct

public class SuperComponent
extends MemberSupport
implements ComponentPro, Member, Sizeable

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface railo.runtime.type.Collection
Collection.Key
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Field Summary
 
Fields inherited from interface railo.runtime.Component
ACCESS_COUNT, ACCESS_PACKAGE, ACCESS_PRIVATE, ACCESS_PUBLIC, ACCESS_REMOTE
 
Fields inherited from interface railo.runtime.type.Struct
TYPE_LINKED, TYPE_REGULAR, TYPE_SOFT, TYPE_SYNC, TYPE_WEAKED
 
Method Summary
 Object call(PageContext pc, Collection.Key name, Object[] args)
          calls a method of the object
 Object call(PageContext pc, String name, Object[] args)
          call a method of the component with no named arguments
 Object callWithNamedValues(PageContext pc, Collection.Key methodName, Struct args)
          call a method of the Object with named arguments
 Object callWithNamedValues(PageContext pc, String name, Struct args)
          call a method of the component with named arguments
 Boolean castToBoolean(Boolean defaultValue)
          cast the castable value to a boolean value
 boolean castToBooleanValue()
          cast the castable value to a boolean value
 DateTime castToDateTime()
          cast the castable value to a date time object
 DateTime castToDateTime(DateTime defaultValue)
          cast the castable value to a date time object
 double castToDoubleValue()
          cast the castable value to a double value
 double castToDoubleValue(double defaultValue)
          cast the castable value to a double value
 String castToString()
          cast the castable value to a string, other than the Method toString, this Method can throw a Exception
 String castToString(String defaultValue)
          cast the castable value to a string, return the default value, when the method is not castable
 void clear()
          clears the collection
 Object clone()
           
 int compareTo(boolean b)
           
 int compareTo(DateTime dt)
           
 int compareTo(double d)
           
 int compareTo(String str)
           
 boolean contains(PageContext pc, Collection.Key key)
           
 boolean containsKey(Collection.Key key)
          contains this key
 boolean containsKey(Object key)
           
 boolean containsKey(String name)
          contains this key
 boolean containsValue(Object value)
           
 Collection duplicate(boolean deepCopy)
           
 Iterator<Map.Entry<Collection.Key,Object>> entryIterator()
           
 Set entrySet()
           
 boolean equalTo(String type)
           
 Object get(Collection.Key key)
          return a value from the collection
 Object get(Collection.Key key, Object defaultValue)
          return a value from the collection, if key doesn't exist, dont throw a exception, reeturns null
 Object get(Object key)
           
 Object get(PageContext pc, Collection.Key key)
          return property or getter of the ContextCollection
 Object get(PageContext pc, Collection.Key key, Object defaultValue)
          return property
 Object get(String name)
          return a value from the collection
 Object get(String name, Object defaultValue)
          return a value from the collection, if key doesn't exist, dont throw a exception, reeturns null
 String getAbsName()
           
 String getBaseAbsName()
           
 String getCallName()
           
 ComponentScope getComponentScope()
           
 String getDisplayName()
           
 String getExtends()
           
 String getHint()
           
 Iterator<String> getIterator()
           
 Class getJavaAccessClass(RefBoolean isNew)
          returns java class to the component interface (all UDFs), this class is generated dynamic when used
 Struct getMetaData(PageContext pc)
          returns Meta Data to the Component
 String getName()
           
 boolean getOutput()
           
 PageSource getPageSource()
           
 Property[] getProperties(boolean onlyPeristent)
          return all properties from component
 Property[] getProperties(boolean onlyPeristent, boolean includeBaseProperties, boolean overrideProperties, boolean inheritedMappedSuperClassOnly)
           
 Object getValue()
          return the value itself
 String getWSDLFile()
           
 boolean instanceOf(String type)
          check if Component is instance of this type
 boolean isBasePeristent()
           
 boolean isEmpty()
           
 boolean isInitalized()
           
 boolean isValidAccess(int access)
          check if value is a valid access modifier constant
 Iterator<Collection.Key> keyIterator()
           
 Collection.Key[] keys()
           
 Iterator<String> keysAsStringIterator()
           
 Set keySet()
           
 Object put(Object key, Object value)
           
 void putAll(Map map)
           
 void registerUDF(Collection.Key key, UDF udf)
           
 void registerUDF(Collection.Key key, UDFProperties props)
           
 void registerUDF(String key, UDF udf)
           
 void registerUDF(String key, UDFProperties props)
           
 Object remove(Collection.Key key)
          removes value from collection and return it when it exists, otherwise throws a exception
 Object remove(Object key)
           
 Object removeEL(Collection.Key key)
          removes value from collection and return it when it exists, otherwise returns null
 Object set(Collection.Key key, Object value)
          sets a value to the collection
 Object set(PageContext pc, Collection.Key key, Object value)
          sets a property (Data Member) value of the object
 Object set(String name, Object value)
          sets a value to the collection
 Object setEL(Collection.Key key, Object value)
          sets a value to the collection, if key doesn't exist, dont throw a exception, returns null
 Object setEL(PageContext pc, Collection.Key name, Object value)
          sets a property (Data Member) value of the object
 Object setEL(String name, Object value)
          sets a value to the collection, if key doesn't exist, dont throw a exception, returns null
 void setProperty(Property property)
           
 int size()
           
 long sizeOf()
          return the size of the object
static Collection superInstance(ComponentImpl comp)
           
static Member superMember(ComponentImpl comp)
           
 DumpData toDumpData(PageContext pageContext, int maxlevel, DumpProperties dp)
          method to print out information to a object as HTML
 Iterator<Object> valueIterator()
           
 Collection values()
           
 
Methods inherited from class railo.runtime.component.MemberSupport
getAccess, setAccess, setAccess
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 
Methods inherited from interface railo.runtime.component.Member
getAccess
 

Method Detail

superMember

public static Member superMember(ComponentImpl comp)

superInstance

public static Collection superInstance(ComponentImpl comp)

getValue

public Object getValue()
Description copied from interface: Member
return the value itself

Specified by:
getValue in interface Member
Returns:
value

call

public Object call(PageContext pc,
                   String name,
                   Object[] args)
            throws PageException
Description copied from interface: Component
call a method of the component with no named arguments

Specified by:
call in interface Component
Parameters:
pc - PageContext
name - name of the method
args - Arguments for the method
Returns:
return result of the method
Throws:
PageException

call

public Object call(PageContext pc,
                   Collection.Key name,
                   Object[] args)
            throws PageException
Description copied from interface: Objects
calls a method of the object

Specified by:
call in interface Objects
name - name of the method to call
args - arguments to call method with
Returns:
return value of the method
Throws:
PageException

callWithNamedValues

public Object callWithNamedValues(PageContext pc,
                                  String name,
                                  Struct args)
                           throws PageException
Description copied from interface: Component
call a method of the component with named arguments

Specified by:
callWithNamedValues in interface Component
Parameters:
pc - PageContext
name - name of the method
args - Named Arguments for the method
Returns:
return result of the method
Throws:
PageException

callWithNamedValues

public Object callWithNamedValues(PageContext pc,
                                  Collection.Key methodName,
                                  Struct args)
                           throws PageException
Description copied from interface: Objects
call a method of the Object with named arguments

Specified by:
callWithNamedValues in interface Objects
Parameters:
pc - PageContext
methodName - name of the method
args - Named Arguments for the method
Returns:
return result of the method
Throws:
PageException

castToBooleanValue

public boolean castToBooleanValue()
                           throws PageException
Description copied from interface: Castable
cast the castable value to a boolean value

Specified by:
castToBooleanValue in interface Castable
Returns:
boolean Value representation of the Object
Throws:
PageException

castToBoolean

public Boolean castToBoolean(Boolean defaultValue)
Description copied from interface: Castable
cast the castable value to a boolean value

Specified by:
castToBoolean in interface Castable
Returns:
boolean Value representation of the Object

castToDateTime

public DateTime castToDateTime()
                        throws PageException
Description copied from interface: Castable
cast the castable value to a date time object

Specified by:
castToDateTime in interface Castable
Returns:
date time representation of the Object
Throws:
PageException

castToDateTime

public DateTime castToDateTime(DateTime defaultValue)
Description copied from interface: Castable
cast the castable value to a date time object

Specified by:
castToDateTime in interface Castable
Parameters:
defaultValue - returned when it is not possible to cast to a dateTime object
Returns:
date time representation of the Object

castToDoubleValue

public double castToDoubleValue()
                         throws PageException
Description copied from interface: Castable
cast the castable value to a double value

Specified by:
castToDoubleValue in interface Castable
Returns:
double Value representation of the Object
Throws:
PageException

castToDoubleValue

public double castToDoubleValue(double defaultValue)
Description copied from interface: Castable
cast the castable value to a double value

Specified by:
castToDoubleValue in interface Castable
Returns:
double Value representation of the Object

castToString

public String castToString()
                    throws PageException
Description copied from interface: Castable
cast the castable value to a string, other than the Method toString, this Method can throw a Exception

Specified by:
castToString in interface Castable
Returns:
String representation of the Object
Throws:
PageException

castToString

public String castToString(String defaultValue)
Description copied from interface: Castable
cast the castable value to a string, return the default value, when the method is not castable

Specified by:
castToString in interface Castable
Returns:
String representation of the Object

clear

public void clear()
Description copied from interface: Collection
clears the collection

Specified by:
clear in interface Map
Specified by:
clear in interface Collection

clone

public Object clone()
Specified by:
clone in interface Collection
Overrides:
clone in class Object
Returns:
this object cloned

compareTo

public int compareTo(boolean b)
              throws PageException
Specified by:
compareTo in interface Castable
Throws:
PageException

compareTo

public int compareTo(DateTime dt)
              throws PageException
Specified by:
compareTo in interface Castable
Throws:
PageException

compareTo

public int compareTo(double d)
              throws PageException
Specified by:
compareTo in interface Castable
Throws:
PageException

compareTo

public int compareTo(String str)
              throws PageException
Specified by:
compareTo in interface Castable
Throws:
PageException

containsKey

public boolean containsKey(String name)
Description copied from interface: Collection
contains this key

Specified by:
containsKey in interface Collection
Returns:
returns if collection has a key with given name

containsKey

public boolean containsKey(Collection.Key key)
Description copied from interface: Collection
contains this key

Specified by:
containsKey in interface Collection
Returns:
returns if collection has a key with given name

duplicate

public Collection duplicate(boolean deepCopy)
Specified by:
duplicate in interface Collection
Specified by:
duplicate in interface Duplicable

get

public Object get(PageContext pc,
                  Collection.Key key)
           throws PageException
Description copied from interface: Objects
return property or getter of the ContextCollection

Specified by:
get in interface Objects
Parameters:
pc - PageContext
key - Name of the Property
Returns:
return value of the Property
Throws:
PageException

get

public Object get(PageContext pc,
                  Collection.Key key,
                  Object defaultValue)
Description copied from interface: Objects
return property

Specified by:
get in interface Objects
Parameters:
pc - PageContext
key - Name of the Property
Returns:
return value of the Property

get

public Object get(String name)
           throws PageException
Description copied from interface: Collection
return a value from the collection

Specified by:
get in interface Collection
Parameters:
name - key of the value to get
Returns:
value on key position
Throws:
PageException

get

public Object get(String name,
                  Object defaultValue)
Description copied from interface: Collection
return a value from the collection, if key doesn't exist, dont throw a exception, reeturns null

Specified by:
get in interface Collection
Parameters:
name - key of the value to get
Returns:
value on key position or null

get

public Object get(Collection.Key key)
           throws PageException
Description copied from interface: Collection
return a value from the collection

Specified by:
get in interface Collection
Parameters:
key - key of the value to get must be lower case
Returns:
value on key position
Throws:
PageException

get

public Object get(Collection.Key key,
                  Object defaultValue)
Description copied from interface: Collection
return a value from the collection, if key doesn't exist, dont throw a exception, reeturns null

Specified by:
get in interface Collection
Parameters:
key - key of the value to get
Returns:
value on key position or null

getAbsName

public String getAbsName()
Specified by:
getAbsName in interface Component
Returns:
Returns the Name.

getBaseAbsName

public String getBaseAbsName()
Specified by:
getBaseAbsName in interface Component

isBasePeristent

public boolean isBasePeristent()
Specified by:
isBasePeristent in interface Component

getCallName

public String getCallName()
Specified by:
getCallName in interface Component
Returns:
Returns the Name.

getDisplayName

public String getDisplayName()
Specified by:
getDisplayName in interface Component
Returns:
Returns the display name.

getExtends

public String getExtends()
Specified by:
getExtends in interface Component
Returns:
Returns the Extends.

getHint

public String getHint()
Specified by:
getHint in interface Component
Returns:
Returns the Hint.

getJavaAccessClass

public Class getJavaAccessClass(RefBoolean isNew)
                         throws PageException
Description copied from interface: Component
returns java class to the component interface (all UDFs), this class is generated dynamic when used

Specified by:
getJavaAccessClass in interface Component
Throws:
PageException - FUTURE deprecated

getMetaData

public Struct getMetaData(PageContext pc)
                   throws PageException
Description copied from interface: Component
returns Meta Data to the Component

Specified by:
getMetaData in interface Component
Returns:
meta data to component
Throws:
PageException

getName

public String getName()
Specified by:
getName in interface Component
Returns:
Returns the Name.

getOutput

public boolean getOutput()
Specified by:
getOutput in interface Component
Returns:
Returns the output.

instanceOf

public boolean instanceOf(String type)
Description copied from interface: Component
check if Component is instance of this type

Specified by:
instanceOf in interface Component
Parameters:
type - type to compare as String
Returns:
is instance of this type

isInitalized

public boolean isInitalized()

isValidAccess

public boolean isValidAccess(int access)
Description copied from interface: Component
check if value is a valid access modifier constant

Specified by:
isValidAccess in interface Component
Returns:
is valid access

keyIterator

public Iterator<Collection.Key> keyIterator()
Specified by:
keyIterator in interface Iteratorable
Returns:
return a Iterator for Keys as Collection.Keys

keysAsStringIterator

public Iterator<String> keysAsStringIterator()
Specified by:
keysAsStringIterator in interface Iteratorable
Returns:
return a Iterator for Keys as String

entryIterator

public Iterator<Map.Entry<Collection.Key,Object>> entryIterator()
Specified by:
entryIterator in interface Iteratorable

keys

public Collection.Key[] keys()
Specified by:
keys in interface Collection
Returns:
returns a string array of all keys in the collection

remove

public Object remove(Collection.Key key)
              throws PageException
Description copied from interface: Collection
removes value from collection and return it when it exists, otherwise throws a exception

Specified by:
remove in interface Collection
Parameters:
key - key of the collection
Returns:
removed Object
Throws:
PageException

removeEL

public Object removeEL(Collection.Key key)
Description copied from interface: Collection
removes value from collection and return it when it exists, otherwise returns null

Specified by:
removeEL in interface Collection
Parameters:
key - key of the collection
Returns:
removed Object

set

public Object set(PageContext pc,
                  Collection.Key key,
                  Object value)
           throws PageException
Description copied from interface: Objects
sets a property (Data Member) value of the object

Specified by:
set in interface Objects
key - property name to set
value - value to insert
Returns:
value set to property
Throws:
PageException

set

public Object set(String name,
                  Object value)
           throws PageException
Description copied from interface: Collection
sets a value to the collection

Specified by:
set in interface Collection
Parameters:
name - key of the new value
value - value to set
Returns:
value setted
Throws:
PageException

set

public Object set(Collection.Key key,
                  Object value)
           throws PageException
Description copied from interface: Collection
sets a value to the collection

Specified by:
set in interface Collection
Parameters:
key - key of the new value
value - value to set
Returns:
value setted
Throws:
PageException

setEL

public Object setEL(PageContext pc,
                    Collection.Key name,
                    Object value)
Description copied from interface: Objects
sets a property (Data Member) value of the object

Specified by:
setEL in interface Objects
name - property name to set
value - value to insert
Returns:
value set to property

setEL

public Object setEL(String name,
                    Object value)
Description copied from interface: Collection
sets a value to the collection, if key doesn't exist, dont throw a exception, returns null

Specified by:
setEL in interface Collection
Parameters:
name - key of the value to get
value - value to set
Returns:
value on key position or null

setEL

public Object setEL(Collection.Key key,
                    Object value)
Description copied from interface: Collection
sets a value to the collection, if key doesn't exist, dont throw a exception, returns null

Specified by:
setEL in interface Collection
Parameters:
key - key of the value to get
value - value to set
Returns:
value on key position or null

size

public int size()
Specified by:
size in interface Map
Specified by:
size in interface Collection
Returns:
the size of the collection

toDumpData

public DumpData toDumpData(PageContext pageContext,
                           int maxlevel,
                           DumpProperties dp)
Description copied from interface: Dumpable
method to print out information to a object as HTML

Specified by:
toDumpData in interface Dumpable
Returns:
HTML print out

getPageSource

public PageSource getPageSource()
Specified by:
getPageSource in interface Component

containsKey

public boolean containsKey(Object key)
Specified by:
containsKey in interface Map

entrySet

public Set entrySet()
Specified by:
entrySet in interface Map

get

public Object get(Object key)
Specified by:
get in interface Map

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface Map

keySet

public Set keySet()
Specified by:
keySet in interface Map

put

public Object put(Object key,
                  Object value)
Specified by:
put in interface Map

putAll

public void putAll(Map map)
Specified by:
putAll in interface Map

remove

public Object remove(Object key)
Specified by:
remove in interface Map

values

public Collection values()
Specified by:
values in interface Map

containsValue

public boolean containsValue(Object value)
Specified by:
containsValue in interface Map

valueIterator

public Iterator<Object> valueIterator()
Specified by:
valueIterator in interface Iteratorable
Returns:
return a Iterator for Values

getProperties

public Property[] getProperties(boolean onlyPeristent)
Description copied from interface: Component
return all properties from component

Specified by:
getProperties in interface Component
Parameters:
onlyPeristent - if true return only columns where attribute persistent is not set to false
Returns:

getProperties

public Property[] getProperties(boolean onlyPeristent,
                                boolean includeBaseProperties,
                                boolean overrideProperties,
                                boolean inheritedMappedSuperClassOnly)
Specified by:
getProperties in interface ComponentPro

getComponentScope

public ComponentScope getComponentScope()
Specified by:
getComponentScope in interface Component

contains

public boolean contains(PageContext pc,
                        Collection.Key key)
Specified by:
contains in interface Component

setProperty

public void setProperty(Property property)
                 throws PageException
Specified by:
setProperty in interface Component
Throws:
PageException

sizeOf

public long sizeOf()
Description copied from interface: Sizeable
return the size of the object

Specified by:
sizeOf in interface Sizeable
Returns:
size of the object

equalTo

public boolean equalTo(String type)
Specified by:
equalTo in interface Component

getWSDLFile

public String getWSDLFile()
Specified by:
getWSDLFile in interface Component

registerUDF

public void registerUDF(String key,
                        UDF udf)
Specified by:
registerUDF in interface Component

registerUDF

public void registerUDF(Collection.Key key,
                        UDF udf)
Specified by:
registerUDF in interface Component

registerUDF

public void registerUDF(String key,
                        UDFProperties props)
Specified by:
registerUDF in interface Component

registerUDF

public void registerUDF(Collection.Key key,
                        UDFProperties props)
Specified by:
registerUDF in interface Component

getIterator

public Iterator<String> getIterator()
Specified by:
getIterator in interface ForEachIteratorable


Copyright © 2012 Railo