| java.util.AbstractList
 velosurf.context.EntityReference
| EntityReference | | public EntityReference(Entity entity)(Code) | | Builds a new EntityReference.
Parameters:
entity - the wrapped entity |
| clearRefinement | | public void clearRefinement()(Code) | | Clears any refinement made on this entity.
|
| delete | | public boolean delete(Map<String, Object> values)(Code) | | Detele a row from this entity's table.
Velosurf will ensure all key columns are specified, to avoid an accidental massive update.
Parameters:
values - col -> value map true if successfull, false if an error occurs (in which case $db.error can be checked). |
| delete | | public boolean delete(String keyValue)(Code) | | Detele a row from this entity's table, specifying the value of its unique key column.
Parameters:
keyValue - key value true if successfull, false if an error occurs (in which case $db.error can be checked). |
| delete | | public boolean delete(Number keyValue)(Code) | | Detele a row from this entity's table, specifying the value of its unique key column.
Velosurf will ensure all key columns are specified, to avoid an accidental massive update.
Parameters:
keyValue - key value true if successfull, false if an error occurs (in which case $db.error can be checked). |
| fetch | | public Instance fetch(List<Object> values)(Code) | | Fetch an Instance of this entity, specifying the values of its key columns in their natural order.
Parameters:
values - values of the key columns an Instance, or null if an error occured (in which case$db.error can be checked) |
| fetch | | public Instance fetch(Map<String, Object> values)(Code) | | Fetch an Instance of this entity, specifying the values of its key columns in the map.
Parameters:
values - key=>value map an Instance, or null if an error occured (in which case$db.error can be checked) |
| fetch | | public Instance fetch(String keyValue)(Code) | | Fetch an Instance of this entity, specifying the value of its unique key column as a string
Parameters:
keyValue - value of the key column an Instance, or null if an error occured (in which case$db.error can be checked) |
| fetch | | public Instance fetch(Number keyValue)(Code) | | Fetch an Instance of this entity, specifying the value of its unique key column as an integer
Parameters:
keyValue - value of the key column an Instance, or null if an error occured (in which case$db.error can be checked) |
| get | | public Object get(int i)(Code) | | Dummy method. Since this class has to appear as a Collection for Velocity, it extends the AbstractList class but only the iterator() method has a real meaning.
Parameters:
i - ignored null |
| getColumns | | public List getColumns()(Code) | | Getter for the list of column names.
the list of column names |
| getLastInsertID | | public Object getLastInsertID()(Code) | | Returns the ID of the last inserted row (obfuscated if needed).
last insert ID |
| getName | | public String getName()(Code) | | gets the name of the wrapped entity
|
| getRows | | public List getRows()(Code) | | Get all the rows in a list of maps.
a list of all the rows |
| insert | | public boolean insert(Map<String, Object> values)(Code) | | Insert a new row in this entity's table.
Parameters:
values - col -> value map true if successfull, false if an error occurs (in which case $db.error can be checked). |
| iterator | | public Iterator iterator()(Code) | | Called by the #foreach directive.
a RowIterator on all instances of this entity, possibly previouslyrefined or ordered. |
| newInstance | | public Instance newInstance()(Code) | | Create a new instance for this entity.
the newly created instance |
| newInstance | | public Instance newInstance(Map<String, Object> values)(Code) | | Build a new instance from a Map object.
Parameters:
values - the Map object containing the values the newly created instance |
| refine | | public void refine(String criterium)(Code) | | Refines this entity reference querying result. The provided criterium will be added to the 'where' clause (or a 'where' clause will be added).
This method can be called several times, thus allowing a field-by-field handling of an html search form.
All criteria will be merged with the sql 'and' operator (if there is an initial where clause, it is wrapped into parenthesis).
Example: if we issue the following calls from inside the template:
$person.refine("age>30")
$person.refine("salary>3000")
the resulting query that will be issed is:
select * from person where (age>30) and (salary>3000)
Parameters:
criterium - a valid sql condition |
| setOrder | | public void setOrder(String order)(Code) | | Specify an 'order by' clause for this attribute reference result.
If an 'order by' clause is already present in the original query, the ew one is appended (but successive calls to this method overwrite previous ones).
postfix " DESC " to a column for descending order.
Pass it null or an empty string to clear any ordering.
Parameters:
order - valid sql column names (separated by commas) indicating thedesired order |
| size | | public int size()(Code) | | Dummy method. Since this class has to appear as a Collection for Velocity, it extends the AbstractList class but only the iterator() method has a real meaning.
0 |
| update | | public boolean update(Map<String, Object> values)(Code) | | Update a row in this entity's table.
Velosurf will ensure all key columns are specified, to avoid an accidental massive update.
Parameters:
values - col -> value map true if successfull, false if an error occurs (in which case $db.error can be checked). |
| validate | | public boolean validate(Map<String, Object> values)(Code) | | Validate values of this instance.
Parameters:
values - true if values are valid with respect to defined column constraints |
| Fields inherited from java.util.AbstractList | protected transient int modCount(Code)(Java Doc)
|
|
|