railo.runtime.poi
Class Excel
java.lang.Object
railo.runtime.type.util.StructSupport
railo.runtime.poi.Excel
- All Implemented Interfaces:
- Serializable, Cloneable, Map, Dumpable, Castable, Collection, ForEachIteratorable, Iteratorable, Objects, Sizeable, Struct
public class Excel
- extends StructSupport
- implements Cloneable, Struct
- See Also:
- Serialized Form
Nested classes/interfaces inherited from interface java.util.Map |
Map.Entry<K,V> |
Constructor Summary |
Excel(String sheetName,
short xmlFormat,
int rows)
|
Method Summary |
void |
clear()
clears the collection |
boolean |
containsKey(Collection.Key key)
contains this key |
Collection |
duplicate(boolean deepCopy)
|
Iterator<Map.Entry<Collection.Key,Object>> |
entryIterator()
|
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 |
Struct |
getSummaryInfo()
|
Iterator<Collection.Key> |
keyIterator()
|
Collection.Key[] |
keys()
|
Iterator<String> |
keysAsStringIterator()
|
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 |
setEL(Collection.Key key,
Object value)
sets a value to the collection, if key doesn't exist, dont throw a exception, returns null |
void |
setValue(int rowNumber,
int columnNumber,
String value)
|
int |
size()
|
Iterator<Object> |
valueIterator()
|
void |
write(Resource res,
String password)
|
Methods inherited from class railo.runtime.type.util.StructSupport |
call, callWithNamedValues, castToBoolean, castToBooleanValue, castToDateTime, castToDateTime, castToDoubleValue, castToDoubleValue, castToString, castToString, clone, compareTo, compareTo, compareTo, compareTo, containsKey, containsKey, containsValue, entrySet, equals, get, get, get, get, get, getIterator, hashCode, invalidKey, isEmpty, keySet, put, putAll, remove, set, set, setEL, setEL, sizeOf, toDumpData, toString, values |
Methods inherited from interface java.util.Map |
containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, values |
Methods inherited from interface railo.runtime.op.Castable |
castToBoolean, castToBooleanValue, castToDateTime, castToDateTime, castToDoubleValue, castToDoubleValue, castToString, castToString, compareTo, compareTo, compareTo, compareTo |
FORMAT_UNDEFINED
public static final short FORMAT_UNDEFINED
- See Also:
- Constant Field Values
FORMAT_XSSF
public static final short FORMAT_XSSF
- See Also:
- Constant Field Values
FORMAT_HSSF
public static final short FORMAT_HSSF
- See Also:
- Constant Field Values
FORMAT_SXSSF
public static final short FORMAT_SXSSF
- See Also:
- Constant Field Values
XSSF_FORMAT
public static final String XSSF_FORMAT
- See Also:
- Constant Field Values
HSSF_FORMAT
public static final String HSSF_FORMAT
- See Also:
- Constant Field Values
SXSSF_FORMAT
public static final String SXSSF_FORMAT
- See Also:
- Constant Field Values
Excel
public Excel(String sheetName,
short xmlFormat,
int rows)
write
public void write(Resource res,
String password)
setValue
public void setValue(int rowNumber,
int columnNumber,
String value)
throws CasterException
- Throws:
CasterException
getSummaryInfo
public Struct getSummaryInfo()
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 valuevalue
- 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 getvalue
- value to set
- Returns:
- value on key position or null
duplicate
public Collection duplicate(boolean deepCopy)
- Specified by:
duplicate
in interface Collection
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
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
Copyright © 2012 Railo