railo.runtime
Class ComponentWrap

java.lang.Object
  extended by railo.runtime.type.util.StructSupport
      extended by railo.runtime.ComponentWrap
All Implemented Interfaces:
Serializable, Cloneable, Map, CFObject, Component, ComponentPro, Dumpable, Castable, Collection, ForEachIteratorable, Iteratorable, Objects, Sizeable, Struct

public final class ComponentWrap
extends StructSupport
implements ComponentPro, Objects

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
 
Constructor Summary
ComponentWrap(int access, ComponentAccess component)
          constructor of the class
 
Method Summary
 Object call(PageContext pc, Collection.Key key, Object[] args)
          calls a method of the object
 Object call(PageContext pc, String key, Object[] args)
          call a method of the component with no named arguments
 Object callWithNamedValues(PageContext pc, Collection.Key key, Struct args)
          call a method of the Object with named arguments
 Object callWithNamedValues(PageContext pc, String key, 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
 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
 Collection duplicate(boolean deepCopy)
           
 Iterator<Map.Entry<Collection.Key,Object>> entryIterator()
           
 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(PageContext pc, Collection.Key key)
          return property or getter of the ContextCollection
 Object get(PageContext pc, Collection.Key key, Object defaultValue)
          return property
 String getAbsName()
           
 int getAccess()
           
 String getBaseAbsName()
           
 String getCallName()
           
 ComponentAccess getComponentAccess()
           
 ComponentScope getComponentScope()
           
 String getDisplayName()
           
 String getExtends()
           
 String getHint()
           
 Class getJavaAccessClass(RefBoolean isNew)
          returns java class to the component interface (all UDFs), this class is generated dynamic when used
 Member getMember(int access, Collection.Key key, boolean dataMember, boolean superAccess)
           
 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)
           
 String getWSDLFile()
           
 boolean instanceOf(String type)
          check if Component is instance of this type
 boolean isBasePeristent()
           
 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()
           
 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 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 propertyName, Object value)
          sets a property (Data Member) value of the object
 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 propertyName, Object value)
          sets a property (Data Member) value of the object
 void setProperty(Property property)
           
 int size()
           
static ComponentWrap toComponentWrap(int access, Component component)
           
 DumpData toDumpData(PageContext pageContext, int maxlevel, DumpProperties dp)
          method to print out information to a object as HTML
 Iterator<Object> valueIterator()
           
 
Methods inherited from class railo.runtime.type.util.StructSupport
clone, containsKey, containsKey, containsValue, entrySet, equals, get, get, get, getIterator, hashCode, invalidKey, isEmpty, put, putAll, remove, set, setEL, sizeOf, toString, values
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface railo.runtime.type.Collection
clone, containsKey, get, get, set, setEL
 
Methods inherited from interface railo.runtime.type.ForEachIteratorable
getIterator
 
Methods inherited from interface java.util.Map
containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, put, putAll, remove, values
 
Methods inherited from interface railo.runtime.type.Sizeable
sizeOf
 

Constructor Detail

ComponentWrap

public ComponentWrap(int access,
                     ComponentAccess component)
constructor of the class

Parameters:
access -
component -
Throws:
ExpressionException
Method Detail

toComponentWrap

public static ComponentWrap toComponentWrap(int access,
                                            Component component)
                                     throws ExpressionException
Throws:
ExpressionException

getPageSource

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

keySet

public Set keySet()
Specified by:
keySet in interface Map
Overrides:
keySet in class StructSupport

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.

getName

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

getCallName

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

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

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

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

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

call

public Object call(PageContext pc,
                   String key,
                   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
key - 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 key,
                   Object[] args)
            throws PageException
Description copied from interface: Objects
calls a method of the object

Specified by:
call in interface Objects
Overrides:
call in class StructSupport
key - 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 key,
                                  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
key - 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 key,
                                  Struct args)
                           throws PageException
Description copied from interface: Objects
call a method of the Object with named arguments

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

size

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

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

clear

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

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

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

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(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

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
Overrides:
keysAsStringIterator in class StructSupport
Returns:
return a Iterator for Keys as String

entryIterator

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

valueIterator

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

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

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
Overrides:
toDumpData in class StructSupport
Returns:
HTML print out

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
Overrides:
castToString in class StructSupport
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
Overrides:
castToString in class StructSupport
Returns:
String representation of the Object

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
Overrides:
castToBooleanValue in class StructSupport
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
Overrides:
castToBoolean in class StructSupport
Returns:
boolean Value 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
Overrides:
castToDoubleValue in class StructSupport
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
Overrides:
castToDoubleValue in class StructSupport
Returns:
double 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
Overrides:
castToDateTime in class StructSupport
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
Overrides:
castToDateTime in class StructSupport
Parameters:
defaultValue - returned when it is not possible to cast to a dateTime object
Returns:
date time representation of the Object

compareTo

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

compareTo

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

compareTo

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

compareTo

public int compareTo(double d)
              throws PageException
Specified by:
compareTo in interface Castable
Overrides:
compareTo in class StructSupport
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
Overrides:
get in class StructSupport
Parameters:
pc - PageContext
key - Name of the Property
Returns:
return value of the Property

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
Overrides:
get in class StructSupport
Parameters:
pc - PageContext
key - Name of the Property
Returns:
return value of the Property
Throws:
PageException

duplicate

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

set

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

Specified by:
set in interface Objects
Overrides:
set in class StructSupport
propertyName - property name to set
value - value to insert
Returns:
value set to property
Throws:
PageException

setEL

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

Specified by:
setEL in interface Objects
Overrides:
setEL in class StructSupport
propertyName - property name to set
value - value to insert
Returns:
value set to property

getAccess

public int getAccess()

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

getWSDLFile

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

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

getComponentAccess

public ComponentAccess getComponentAccess()

contains

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

getMember

public Member getMember(int access,
                        Collection.Key key,
                        boolean dataMember,
                        boolean superAccess)

setProperty

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

equalTo

public boolean equalTo(String type)
Specified by:
equalTo 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


Copyright © 2012 Railo