com.smartgwt.client.widgets

Class DataContext

java.lang.Object

com.smartgwt.client.core.JsObject

com.smartgwt.client.core.DataClass

com.smartgwt.client.widgets.DataContext

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers

public class DataContext
extends DataClass

A mapping from DataSource IDs to specific Records.

To understand how dataContext is used to automatically populate DataBoundComponents, see Canvas.autoPopulateData.

For example, in SmartGWT:

    Record customerRecord = new Record();
    customerRecord.setAttribute("customerNumber", "15");
    customerRecord.setAttribute("name", "Trish Joiner");
 
    Record employeeRecord = new Record();
    employeeRecord.setAttribute("employeeID", "4231");
    employeeRecord.setAttribute("name", "Fred Smith");
 
    DataContext dataContext = new DataContext();
    dataContext.addMapping("Customer", customerRecord);
    dataContext.addMapping("Employee", employeeRecord);
  

Field Summary

Fields inherited from class com.smartgwt.client.core.DataClass

factoryCreated, factoryProperties

Fields inherited from class com.smartgwt.client.core.JsObject

jsObj

Constructor Summary

Constructors

Constructor and Description
DataContext()
DataContext(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method and Description
DataContext	addMapping(DataSource dataSource, Record record) Maps the record to the supplied DataSource.
DataContext	addMapping(java.lang.String dataSourceID, Record record) Maps the record to the supplied DataSource ID.
java.util.Set<java.lang.String>	getMappedDataSources() Returns set of all DataSource IDs currently mapped for this DataContext.
Record[]	getMapping(DataSource dataSource) Returns record(s) mapped to the supplied DataSource.
Record[]	getMapping(java.lang.String dataSourceID) Returns record mapped to the supplied DataSource ID.
java.util.Map<java.lang.String,Record[]>	getMappings() Returns all current mappings of DataSource IDs to records for this DataContext.
Record	getMappingSingle(DataSource dataSource) Returns record mapped to the supplied DataSource.
Record	getMappingSingle(java.lang.String dataSourceID) Returns record mapped to the supplied DataSource ID.
static DataContext	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
Record[]	removeMapping(DataSource dataSource) Unmaps the supplied DataSource so it doesn't correspond to any record.
Record[]	removeMapping(java.lang.String dataSourceID) Unmaps the supplied DataSource ID so it doesn't correspond to any record.
DataContext	setMapping(DataSource dataSource, Record... record) Sets the DataSource to map to the supplied record(s).
DataContext	setMapping(java.lang.String dataSourceID, Record... record) Sets the DataSource ID to map to the supplied record(s).

Methods inherited from class com.smartgwt.client.core.DataClass

applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated

Methods inherited from class com.smartgwt.client.core.JsObject

equals, getJsObj, hashCode, isCreated, setJavaScriptObject, setJsObj

Methods inherited from class java.lang.Object

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

Constructor Detail

DataContext

public DataContext()

DataContext

public DataContext(com.google.gwt.core.client.JavaScriptObject jsObj)

Method Detail

getOrCreateRef

public static DataContext getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

addMapping

public DataContext addMapping(DataSource dataSource,
                              Record record)

Maps the record to the supplied DataSource.

Parameters:

dataSource -

record -

Returns:

DataContext instance, for chaining setter calls

addMapping

public DataContext addMapping(java.lang.String dataSourceID,
                              Record record)

Maps the record to the supplied DataSource ID.

Parameters:

dataSourceID -

record -

Returns:

DataContext instance, for chaining setter calls

setMapping

public DataContext setMapping(DataSource dataSource,
                              Record... record)

Sets the DataSource to map to the supplied record(s).

Parameters:

dataSource -

record -

Returns:

DataContext instance, for chaining setter calls

setMapping

public DataContext setMapping(java.lang.String dataSourceID,
                              Record... record)

Sets the DataSource ID to map to the supplied record(s).

Parameters:

dataSource -

record -

Returns:

DataContext instance, for chaining setter calls

getMapping

public Record[] getMapping(DataSource dataSource)

Returns record(s) mapped to the supplied DataSource.

Parameters:

dataSource -

Returns:

mapped record(s), or null

getMapping

public Record[] getMapping(java.lang.String dataSourceID)

Returns record mapped to the supplied DataSource ID.

Parameters:

dataSourceID -

Returns:

mapped record(s), or null

getMappingSingle

public Record getMappingSingle(DataSource dataSource)

Returns record mapped to the supplied DataSource.

Parameters:

dataSource -

Returns:

mapped record

getMappingSingle

public Record getMappingSingle(java.lang.String dataSourceID)

Returns record mapped to the supplied DataSource ID.

Parameters:

dataSourceID -

Returns:

mapped record

removeMapping

public Record[] removeMapping(DataSource dataSource)

Unmaps the supplied DataSource so it doesn't correspond to any record.

Parameters:

dataSource -

Returns:

mapped record(s), or null

removeMapping

public Record[] removeMapping(java.lang.String dataSourceID)

Unmaps the supplied DataSource ID so it doesn't correspond to any record.

Parameters:

dataSourceID -

Returns:

mapped record(s), or null

getMappings

public java.util.Map<java.lang.String,Record[]> getMappings()

Returns all current mappings of DataSource IDs to records for this DataContext.

Returns:

map of DataSource IDs to arrays of records

getMappedDataSources

public java.util.Set<java.lang.String> getMappedDataSources()

Returns set of all DataSource IDs currently mapped for this DataContext.

Returns:

mapped DataSource IDs