MesosferDataSchema

java.lang.Object
- com.eyro.mesosfer.MesosferDataSchema

```
public final class MesosferDataSchema
extends java.lang.Object
```
The MesosferDataSchema is a local representation of schema that can be saved and retrieved from the Mesosfer cloud.
The basic workflow for creating new schema is to construct a new MesosferDataSchema by accessing createSchema(String), use addColumn(String, MesosferObject.Type) to fill it with data, and then use saveAsync(SaveCallback) to persist to the cloud.
The basic workflow for accessing existing data is to use a MesosferQuery to specify which existing data to retrieve.

Author:

Eyro Labs

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MesosferDataSchema`	`addColumn(java.lang.String name, MesosferObject.Type type)` Add a column for `MesosferDataSchema`
`static MesosferDataSchema`	`createSchema(java.lang.String bucket)` Constructs a new `MesosferDataSchema` with no data in it.
`static MesosferDataSchema`	`createWithObjectId(java.lang.String objectId)` Creates a reference to an existing `MesosferDataSchema` for use in creating associations between `MesosferDataSchema`s.
`void`	`deleteAsync(DeleteCallback callback)` Deletes this object on the server in a background thread.
`MesosferDataSchema`	`deleteColumn(java.lang.String name)` Delete a column from a `MesosferDataSchema`
`void`	`fetchAsync(GetCallback<MesosferDataSchema> callback)` Fetches this object with the data from the server in a background thread.
`java.lang.String`	`getBucket()` Gets the bucket name of this `MesosferDataSchema`
`java.util.List<MesosferColumn>`	`getColumn()` Gets the list of column for `MesosferDataSchema`.
`java.util.Date`	`getCreatedAt()` This reports time as the server sees it, so that if you create a `MesosferDataSchema`, then wait a while, and then call `saveAsync(SaveCallback)`, the creation time will be the time of the first `saveAsync(SaveCallback)` call rather than the time the object was created locally.
`java.lang.String`	`getObjectId()` Accessor to the object id.
`static MesosferQuery<MesosferDataSchema>`	`getQuery()` Constructs a query for `MesosferDataSchema`.
`static MesosferQuery<MesosferDataSchema>`	`getQuery(java.lang.String bucket)` Constructs a query for `MesosferData`.
`java.util.Date`	`getUpdatedAt()` This reports time as the server sees it, so that if you make changes to a `MesosferDataSchema`, then wait a while, and then call `saveAsync(SaveCallback)`, the updated time will be the time of the `saveAsync(SaveCallback)` call rather than the time the object was changed locally.
`boolean`	`isDataAvailable()` Gets whether the `MesosferDataSchema` has been fetched.
`void`	`saveAsync(SaveCallback callback)` Saves this object with the data from the server in a background thread.
`org.json.JSONObject`	`toJSON()` To put all keys and values of this `MesosferData` into a `JSONObject`.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - createSchema
```
public static MesosferDataSchema createSchema(java.lang.String bucket)
```
    Constructs a new MesosferDataSchema with no data in it. A MesosferDataSchema constructed in this way will not have an objectId and will not persist to the database until saveAsync(SaveCallback) is called.
    Bucket names must be alphanumerical, and must start with a letter. It is recommended to name classes in MesosferCaseLikeThis.
    
    Parameters:
    
    bucket - the bucket name for this MesosferDataSchema
    
    Returns:
    
    A new instance of MesosferDataSchema
  - createWithObjectId
```
public static MesosferDataSchema createWithObjectId(java.lang.String objectId)
```
    Creates a reference to an existing MesosferDataSchema for use in creating associations between MesosferDataSchemas. Calling isDataAvailable() on this object will return false until fetchAsync(GetCallback) has been called.
    
    Parameters:
    
    objectId - The object id for the referenced object.
    
    Returns:
    
    A MesosferDataSchema without data.
  - isDataAvailable
```
public boolean isDataAvailable()
```
    Gets whether the MesosferDataSchema has been fetched.
    
    Returns:
    
    true if the MesosferDataSchema is new or has been fetched. false otherwise.
  - getBucket
```
public java.lang.String getBucket()
```
    Gets the bucket name of this MesosferDataSchema
    
    Returns:
    
    the bucket name MesosferDataSchema
  - getColumn
```
public java.util.List<MesosferColumn> getColumn()
```
    Gets the list of column for MesosferDataSchema.
    
    Returns:
    
    the list of column
  - getObjectId
```
public java.lang.String getObjectId()
```
    Accessor to the object id. An object id is assigned as soon as an object is saved to the server. The combination of a bucketName and an objectId uniquely identifies an object in your application.
    
    Returns:
    
    The object id.
  - getCreatedAt
```
public java.util.Date getCreatedAt()
```
    This reports time as the server sees it, so that if you create a MesosferDataSchema, then wait a while, and then call saveAsync(SaveCallback), the creation time will be the time of the first saveAsync(SaveCallback) call rather than the time the object was created locally.
    
    Returns:
    
    The first time this object was saved on the server.
  - getUpdatedAt
```
public java.util.Date getUpdatedAt()
```
    This reports time as the server sees it, so that if you make changes to a MesosferDataSchema, then wait a while, and then call saveAsync(SaveCallback), the updated time will be the time of the saveAsync(SaveCallback) call rather than the time the object was changed locally.
    
    Returns:
    
    The last time this object was updated on the server.
  - deleteColumn
```
public MesosferDataSchema deleteColumn(java.lang.String name)
```
    Delete a column from a MesosferDataSchema
    
    Parameters:
    
    name - The name of column
    
    Returns:
    
    The current instance MesosferDataSchema for chaining task
  - addColumn
```
public MesosferDataSchema addColumn(java.lang.String name,
                                    MesosferObject.Type type)
```
    Add a column for MesosferDataSchema
    
    Parameters:
    
    name - The name of column
    
    type - The MesosferObject.Type of column
    
    Returns:
    
    The current instance MesosferDataSchema for chaining task
  - fetchAsync
```
public void fetchAsync(GetCallback<MesosferDataSchema> callback)
```
    Fetches this object with the data from the server in a background thread. This is the preferable method, unless your code is already running from a background thread.
    
    Parameters:
    
    callback - callback.done(object, e) is called when the fetch completes.
  - saveAsync
```
public void saveAsync(SaveCallback callback)
```
    Saves this object with the data from the server in a background thread. This is the preferable method, unless your code is already running from a background thread.
    
    Parameters:
    
    callback - callback.done(e) is called when the save completes.
  - deleteAsync
```
public void deleteAsync(DeleteCallback callback)
```
    Deletes this object on the server in a background thread. This is the preferable method, unless your code is already running from a background thread.
    
    Parameters:
    
    callback - callback.done(e) is called when the save completes.
  - getQuery
```
public static MesosferQuery<MesosferDataSchema> getQuery()
```
    Constructs a query for MesosferDataSchema.
  - getQuery
```
public static MesosferQuery<MesosferDataSchema> getQuery(java.lang.String bucket)
```
    Constructs a query for MesosferData.
    
    Parameters:
    
    bucket - The bucket name that used for MesosferData
  - toJSON
```
public org.json.JSONObject toJSON()
```
    To put all keys and values of this MesosferData into a JSONObject.
    
    Returns:
    
    The JSONObject of all keys and values
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class MesosferDataSchema

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createSchema

createWithObjectId

isDataAvailable

getBucket

getColumn

getObjectId

getCreatedAt

getUpdatedAt

deleteColumn

addColumn

fetchAsync

saveAsync

deleteAsync

getQuery

getQuery

toJSON

toString