io.cloudboost

Class CloudObject

java.lang.Object

io.cloudboost.CloudObject

Direct Known Subclasses:

CloudRole, CloudUser

public class CloudObject
extends Object

Wraps a single record from a table

Author:

Ben

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<String>	_modifiedColumns
ACL	acl
protected JSONObject	document

Constructor Summary

Constructors

Constructor and Description
CloudObject(String tableName) Create a new CloudObject Constructor
CloudObject(String tableName, String id) Constructor

Method Summary

Modifier and Type	Method and Description
void	delete(CloudObjectCallback callbackObject) Delete
void	deleteAll(CloudObject[] array, CloudObjectArrayCallback callback) delete an array of cloudobjects
void	fetch(CloudObjectCallback callbackObject) Fetch
Object	get(String columnName) Get
ACL	getAcl() returns the underlying permission object of this object
Object[]	getArray(String columnName) get a value from this object as an array, cast to JSONArray
Boolean	getBoolean(String columnName)
CloudObject	getCloudObject(String columnName) get a cloud object saved in this cloudobject
CloudObject[]	getCloudObjectArray(String columnName) get an array of cloudobjects in this cloudobject
Date	getCreatedAt() get the date of creation of this object
JSONObject	getDocument() returns the underlying json document with all data about the record, do not modify this object unless you are absolutely sure of what you are doing
Double	getDouble(String columnName)
Calendar	getExpires() get when this cloudobject will expire
CloudFile	getFile(String columnName)
String	getId() get the id of this object if its already saved, otherwise null
Integer	getInteger(String columnName)
boolean	getIsSearchable() returns true if search can be performed on this object
String	getString(String columnName)
Date	getUpdatedAt() get the last update date of this object
boolean	hasKey(String key) returns true if this cloudobject contains a given key
static void	off(String tableName, String[] eventType, CloudStringCallback callbackObject)
static void	off(String tableName, String eventType, CloudStringCallback callbackObj) stop listening to events
static void	on(String tableName, String[] eventType, CloudObjectCallback callbackObject) start listening to an array of events
static void	on(String tableName, String[] eventType, CloudQuery query, CloudObjectCallback callbackObject) start listening to an array of events
static void	on(String tableName, String eventType, CloudObjectCallback callbackObject) start listening to an event
static void	on(String tableName, String eventType, CloudQuery cloudQuery, CloudObjectCallback callbackObject) start listening to events
void	relate(String columnName, String tableName, String objectId) Relates another CloudObject to this one
void	save(CloudObjectCallback callbackObject) writes this cloudobject to the database
void	saveAll(CloudObject[] array, CloudObjectArrayCallback callback) save an array of cloudobjects at once
void	set(String columnName, CloudObject[] data)
void	set(String columnName, Object data) Set a value to this cloudobject as object
void	set(String columnName, Object[] data) Set a value as an array
void	setAcl(ACL acl) set the Access Control List for this record
void	setDocument(JSONObject document) replaces the underlying json object
void	setExpires(Calendar value) set expiry time for this cloudobject, after which it will not appear in queries and searches
void	setIsSearchable(boolean value) should this object appear in searches
void	unset(String columnName) UnSet
protected static boolean	validateNotificationQuery(CloudObject object, CloudQuery query)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

acl

public ACL acl

document

protected JSONObject document

_modifiedColumns

protected ArrayList<String> _modifiedColumns

Constructor Detail

CloudObject

public CloudObject(String tableName)

Create a new CloudObject Constructor

Parameters:

tableName - -name of table to wrap

CloudObject

public CloudObject(String tableName,
                   String id)

Constructor

Parameters:

tableName -

id -

Method Detail

getDocument

public JSONObject getDocument()

returns the underlying json document with all data about the record, do not modify this object unless you are absolutely sure of what you are doing

Returns:

document

setDocument

public void setDocument(JSONObject document)

replaces the underlying json object

Parameters:

document -

setAcl

public void setAcl(ACL acl)

set the Access Control List for this record

Parameters:

acl -

getId

public String getId()

get the id of this object if its already saved, otherwise null

Returns:

_id

getCreatedAt

public Date getCreatedAt()

get the date of creation of this object

Returns:

createdAt

getUpdatedAt

public Date getUpdatedAt()

get the last update date of this object

Returns:

updatedAt

getIsSearchable

public boolean getIsSearchable()

returns true if search can be performed on this object

Returns:

_isSearchable

setIsSearchable

public void setIsSearchable(boolean value)

should this object appear in searches

Parameters:

value -

getExpires

public Calendar getExpires()

get when this cloudobject will expire

Returns:

expiry date

setExpires

public void setExpires(Calendar value)

set expiry time for this cloudobject, after which it will not appear in queries and searches

Parameters:

value -

hasKey

public boolean hasKey(String key)

returns true if this cloudobject contains a given key

Parameters:

key - key to search for

Returns:

boolean

set

public void set(String columnName,
                Object data)
         throws CloudException

Set a value to this cloudobject as object

Parameters:

columnName -

data -

Throws:

CloudException

set

public void set(String columnName,
                Object[] data)
         throws CloudException

Set a value as an array

Parameters:

columnName -

data -

Throws:

CloudException

set

public void set(String columnName,
                CloudObject[] data)
         throws CloudException

Throws:

CloudException

get

public Object get(String columnName)

Get

Parameters:

columnName -

Returns:

a property by name

getInteger

public Integer getInteger(String columnName)

getBoolean

public Boolean getBoolean(String columnName)

getDouble

public Double getDouble(String columnName)

getString

public String getString(String columnName)

getCloudObject

public CloudObject getCloudObject(String columnName)

get a cloud object saved in this cloudobject

Parameters:

columnName -

Returns:

CloudObject

getCloudObjectArray

public CloudObject[] getCloudObjectArray(String columnName)

get an array of cloudobjects in this cloudobject

Parameters:

columnName - column name under which they are saved

Returns:

CloudObject[]

getArray

public Object[] getArray(String columnName)

get a value from this object as an array, cast to JSONArray

Parameters:

columnName -

Returns:

array property by key

unset

public void unset(String columnName)

UnSet

Parameters:

columnName -

relate

public void relate(String columnName,
                   String tableName,
                   String objectId)
            throws CloudException

Relates another CloudObject to this one

Parameters:

columnName - column name to save to, should be of type relate and related to table in parameter

tableName - table the relation column is related to

objectId - the object's ID, it should have been already saved

Throws:

CloudException

on

public static void on(String tableName,
                      String eventType,
                      CloudQuery cloudQuery,
                      CloudObjectCallback callbackObject)
               throws CloudException

start listening to events

Parameters:

tableName - table to listen to events from

eventType - one of created, deleted, updated

cloudQuery - filter to apply on the data

callbackObject -

Throws:

CloudException

on

public static void on(String tableName,
                      String eventType,
                      CloudObjectCallback callbackObject)
               throws CloudException

start listening to an event

Parameters:

tableName - tablename to listen from

eventType - one of "created","deleted" and "updated"

callbackObject - fired when event occurs

Throws:

CloudException

on

public static void on(String tableName,
                      String[] eventType,
                      CloudObjectCallback callbackObject)
               throws CloudException

start listening to an array of events

Parameters:

tableName - tablename to listen from

eventType - one of "created","deleted" and "updated"

callbackObject - fired when event occurs

Throws:

CloudException

on

public static void on(String tableName,
                      String[] eventType,
                      CloudQuery query,
                      CloudObjectCallback callbackObject)
               throws CloudException

start listening to an array of events

Parameters:

tableName - tablename to listen from

eventType - any of "created","deleted" and "updated"

query - a filter to specify details of the record to receive notifications for

callbackObject -

Throws:

CloudException

off

public static void off(String tableName,
                       String[] eventType,
                       CloudStringCallback callbackObject)
                throws CloudException

Throws:

CloudException

off

public static void off(String tableName,
                       String eventType,
                       CloudStringCallback callbackObj)
                throws CloudException

stop listening to events

Parameters:

tableName - table name to stop listening from

eventType - one of "created","deleted" and "updated"

callbackObj - callback fired when the event is cancelled

Throws:

CloudException

save

public void save(CloudObjectCallback callbackObject)
          throws CloudException

writes this cloudobject to the database

Parameters:

callbackObject -

Throws:

CloudException

deleteAll

public void deleteAll(CloudObject[] array,
                      CloudObjectArrayCallback callback)
               throws CloudException

delete an array of cloudobjects

Parameters:

array -

callback -

Throws:

CloudException

saveAll

public void saveAll(CloudObject[] array,
                    CloudObjectArrayCallback callback)
             throws CloudException

save an array of cloudobjects at once

Parameters:

array -

callback -

Throws:

CloudException

fetch

public void fetch(CloudObjectCallback callbackObject)
           throws CloudException

Fetch

Parameters:

callbackObject -

Throws:

CloudException

delete

public void delete(CloudObjectCallback callbackObject)
            throws CloudException

Delete

Parameters:

callbackObject -

Throws:

CloudException

validateNotificationQuery

protected static boolean validateNotificationQuery(CloudObject object,
                                                   CloudQuery query)

getFile

public CloudFile getFile(String columnName)
                  throws CloudException

Throws:

CloudException

getAcl

public ACL getAcl()

returns the underlying permission object of this object

Returns:

ACL