JBStrap Elasticsearch DataDescriptor

ElasticSearch DataDescriptors are used to describe the structure of the data stored in the ElasticSearch index. ElasticSearch DataDescriptors access data through the ElasticSearch DAO layer. DataDescriptors require the use of entity classes. ElasticSearch DataDescriptors allow you to read and write the data stored in the ElasticSearch index.

Creating a simple ElasticSearch DataDescriptor with an XML structure:

         <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE xml>
<datadescriptor name="Example" dataClass="com.jbstrap.sample.domain.Example" connectorType="ElasticSearch">
 <access>
   <type>Public</type>
 </access>
 <column name="supplierId" datatype="NUMBER" primaryKey="true" nullable="false" />
 <column name="supplierName" datatype="VARCHAR2" length="255" />
 <column name="supplierCountry" datatype="VARCHAR2" length="40" />
</datadescriptor>
        

Programmatically creating an ElasticSearch DataDescriptor that corresponds to the above XML:

         ElasticSearchDataDescriptor dataDescriptor = new ElasticSearchDataDescriptor("Example", "com.jbstrap.sample.domain.Example")
	.setAccess(AccessType.PUBLIC)
	.addColumn(new DataDescriptorColumn("supplierId", DataDescriptorColumnDatatype.LONG, "Example")
		.setPrimaryKey(true)
		.setNullable(false)
	)
	.addColumn(new DataDescriptorColumn("supplierName", DataDescriptorColumnDatatype.TEXT, "Example")
		.setLength(255)
	)
	.addColumn(new DataDescriptorColumn("supplierCountry", DataDescriptorColumnDatatype.LONG, "Example")
		.setLength(40)
	);
        

ElasticSearch DataDescriptors can perform any type of data handling operation, you can read data from the ElasticSearch index and you can update or remove existing data.

Fetching all documents from the ElasticSearch index using the data descriptor:

Fetching all documents corresponding to the given criteria from the ElasticSearch index using the data descriptor:

         List<DataRecord> result = dataDescriptor.find(new Criteria("supplierCountry", OperatorType.EQUALS, "USA"));
        

Fetching a document using its ID:

Saving a document to the ElasticSearch index using a data descriptor:

Removing a record using a data descriptor:

Data descriptors also support transaction handling. To handle a transaction, you need to specify an ESTransaction for the DataDescriptor.

Fetching a document, upadting and saving it within a single transaction:

         // Start new transaction
ESTransaction transaction = new ESTransaction();
// Read record from the database
DataRecord supplier = dataDescriptor.findById(transaction, null, 25L);
// Modify the record value
supplier.setValue("supplierName", "New Supplier Name");
// Save the modified record to the database
dataDescriptor.save(supplier, null, transaction);
// Commit the changes in the database
transaction.commit();
        