Data type DatasetContainer

Value range of the data type DatasetContainer

FirstSpirit provides the data type DatasetContainer for the processing of values which represent structured data from the Content Store of FirstSpirit. The data type DatasetContainer represents a logical grouping of an entity (Entity data type) from a database and the relating table template of a FirstSpirit project.

For further information about the data type DatasetContainer see API documentation:

de.espirit.firstspirit.access.editor.value.DatasetContainer

Definition using the standard input components

Using the input component FS_DATASET a dataset is referenced from the Content Store (analogous to the zur input component CMS_INPUT_OBJECTCHOOSER). This input component returns the data type DatasetContainer by means of a $CMS_VALUE(...)$ instruction when accessing the stored value.

Creating DatasetContainer programmatically

If you want to create new DatasetContainer object, which contains a specific entity, programmatically, you can use the methods of the sub-object Factory. This new DatasetContainer can then be assigned as value to a FS_DATASET component.

The methods of the Factory object are specified in the API documentation: de.espirit.firstspirit.access.editor.value.DatasetContainer.Factory

For creating a DatasetContainer a new object of the type DatasetContainer.Factory must be instantiated first. By means of the methods create(...) of this object a data record or an entity, a table template and a project language can be used to create a new DatasetContainer object, configured with these elements. This object will then be assigned to the form of a FS_DATASET input component:

//!Beanshell

import de.espirit.firstspirit.access.store.Store;
import de.espirit.firstspirit.access.editor.value.DatasetContainer;
import de.espirit.firstspirit.access.editor.value.DatasetContainer.Factory;

// Setup
element = context.getElement();
userService = context.getUserService();
projectLanguage = context.getProject().getMasterLanguage();

// Obtain an entity from the Content Store
contentStoreRoot = userService.getStore(Store.Type.CONTENTSTORE);
dataSource = contentStoreRoot.getContent2ByName("myDataSourceUID");
tableTemplate = dataSource.getTemplate();
entity = dataSource.getData().get(0);

//
// Create new DatasetContainer object and assign it to an FS_DATASET input component
//

// Prepare the store element for editing and obtain form data
element.setLock(true, false);
formData = element.getFormData();
fsDatasetField = formData.get(projectLanguage, "fsDatasetComponentLabel");

// Use DatasetContainer.Factory to create a new DatasetContainer with the entity we've obtained earlier
DatasetContainer.Factory datasetContainerFactory = new DatasetContainer.Factory();
DatasetContainer newDatasetContainer = datasetContainerFactory.create(entity, tableTemplate, projectLanguage);

// Assign the new DatasetContainer to the FS_DATASET field and save the store element
fsDatasetField.set(newDatasetContainer);
element.setFormData(formData);
element.save();
element.setLock(false);
element.refresh();

Methods on DatasetContainer objects

The table below lists all methods which can be invoked on objects of data type DatasetContainer:

compareTo(Comparable)

Overview

equals(Object)

Overview

getClass

The .getClass() (in Bean syntax: .class) method returns the class of the invoking object (cf. java.lang.Class).

Invocation:

$CMS_VALUE(myString.class)$
$CMS_VALUE(myString.getClass())$

Output:

java.lang.String

Overview

getDataset

Overview

getGid

Overview

getKey

Overview

getLanguage

Overview

getTemplateUid

Overview

isCase(Object)

Overview

isEmpty

Overview

isNull

The .isNull() (in Bean syntax: .isNull) method checks whether an expression or object is null , e.g. storeElement.isNull(). In the case of objects with complex values or objects, the object decides when it is null. The data type DomElement for example always contains an empty document, thus it is never null. For this reason, checking an empty DOM editor input component by using the method .isNull() returns the value false, whereas checking the component with .isEmpty() would return the value true.

The method .isNull() returns a Boolean value as the check result. true is the check result if the expression or object is null and false if not.

Overview

print

Overview

set(String, Object)

Overview

toJson

Overview

toString

Overview

type

Overview