 |
Page History
<?xml version="1.0" encoding="utf-8"?>
<html>Template:Menu LexEVS 6.0 CTS2
| Scrollbar | ||
|---|---|---|
|
| Page info | ||||
|---|---|---|---|---|
|
| Panel | ||||
|---|---|---|---|---|
| ||||
|
Introduction
LexEVS CTS2 Value Set Authoring API provides capability to author Value Set Definition, its Properties, Definition Entries (rule set) and its Versionable attributes.
...
- New Value Set
- Add new Definition Entry (Rule Set) to Value Set
- Add new property to Value Set
Panel *Edit - This function provides capability to update:
- Value Set meta-data
- Definition Entry of a Value Set
- Property of a Value Set
Panel *Remove - This function provides capability to remove:
- Value Set
- Definition Entry of a Value Set
- Property of a Value Set
Panel *Versionable Change - This function provides capability to modify versionable attributes of Usage Context like Status, Effective Date, Expiration Date, isActive and Owner:
- Value Set Status
- Value Set Versionable attributes
Interface
org.lexevs.cts2.author.ValueSetAuthoringOperation is the main interface for all the authoring operations against Value Set. This interface can be accessed using main LexEVSCTS2 interface, like:
<source>
org.lexevs.cts2.author.ValueSetAuthoringOperation vsAuthOp = new org.lexevs.cts2.LexEvsCTS2Impl().getAuthoringOperation().getValueSetAuthoringOperation();
</source>
Revision Information
All the authoring functions described here requires information about the author and revision/version id to be assigned to entities for each of these operations. These is done passing object org.lexevs.cts2.core.update.RevisionInfo. RevisionInfo object has following attributes:
| Panel |
|---|
java.lang.String changeAgent - (Optional) The source that participated in this particular change. |
Authoring Functions
Following sections contains detailed functions provided by ValueSetAuthoringOperation interface.
Create Operations
Create Operation provides capability to create Value Set, Definition Entry and Properties. For every entry that gets created, a unique revision(version) identifier will be assigned to that entry. This helps in retrieving snapshots of an entry based on its revision(version) identifier. This unique id can be passed in using the RevisionInfo object described above.
createValueSet
This function creates a new Value Set. The new Value Set is defined by the set of meta-data properties that describe it.
...
"Authoring create vsd junit test1",
"Automobiles", "Autos", null, null,
props, null, null, revInfo);'' |
createValueSet using ValueSetDefinition object
This function is similar to above except this allows users to create Value Set by passing well defined value set definition object. The new Value Set is defined by the set of meta-data properties that describe it.
...
| Panel |
|---|
URI vsdURI = vsAuthOp.createValueSet(vsd, revInfo); | |
addDefinitionEntry
This function provides capability to add new Definition Entry (Rule Set) to Value Set Definition.
...
| Panel |
|---|
boolean created = vsAuthOp.addDefinitionEntry(new URI("VSD:AUTHORING:JUNIT:TEST2"), newDefEntry, revInfo); | |
addValueSetProperty
This function provides capability to add a new property to a Value Set.
...
| Panel |
|---|
''boolean added = vsAuthOp.addValueSetProperty(new URI("VSD:AUTHORING:JUNIT:TEST1"), |
prop, revInfo));'' |
Edit Operations
The edit operation provides the capability to modify Value Set meta-data, it's definition entires (rule sets) and its properties. For every entry that gets modified, a unique revision(version) identifier will be assigned to that entry. This helps in retrieving snapshots of an entry based on its revision(version) identifier. This unique id can be passed in using the RevisionInfo object described above.
updateValueSetMetaData
This function provides capability to modify existing meta-data of a value set definition.
...
"VSD after metatdate update vsdR250",
null, "Autos CD update vsdR250", srcList, contextList,
revInfo);'' |
updateDefinitionEntry
This function provides capability to modify existing Definition Entry of a Value Set Definition.
...
| Panel |
|---|
boolean updated = vsAuthOp.updateDefinitionEntry(new URI("VSD:AUTHORING:JUNIT:TEST2"), changedDefinitionEntry, revInfo); | |
updateValueSetProperty
This function provides capability to modify existing property of a Value Set Definition.
...
| Panel |
|---|
boolean updated = vsAuthOp.updateValueSetProperty(new URI("VSD:AUTHORING:JUNIT:TEST1"), prop, revInfo); | |
Remove Operations
Remove operation provides capability to remove Value Set, its definition entry and its property.
removeValueSet
This function provides capability to remove a Value Set. This operation is permanent removal of value set definition.
...
| Panel |
|---|
boolean removed = vsAuthOp.removeValueSet(new URI("VSD:AUTHORING:JUNIT:TEST1"), revInfo); | |
removeDefinitionEntry
This function provides capability to remove Definition Entry (rule set) of a Value Set.
...
| Panel |
|---|
boolean removed = vsAuthOp.removeDefinitionEntry(new URI("VSD:AUTHORING:JUNIT:TEST2"), 1L, revInfo); | |
removeValueSetProperty
This function provides capability to remove property of a Value Set.
...
| Panel |
|---|
boolean removed = vsAuthOp.removeValueSetProperty(new URI("VSD:AUTHORING:JUNIT:TEST1"), "propertyId1", revInfo)); | |
Versionable Change Operations
Versionable Change operation provides capability to modify versionable attributes of Value Set like Status, Effective Date, Expiration Date, isActive and Owner.
updateValueSetStatus
This function modifies the status of a Value Set.
...
| Panel |
|---|
boolean changed = vsAuthOp.updateValueSetStatus(new URI("VSD:AUTHORING:JUNIT:TEST2"), "pending", revInfo));; | |
updateValueSetVersionable
This function provides capability to modify Value Set versionable attributes like effective date, expiration date, owner, status etc.
...
| Panel |
|---|
boolean changed = vsAuthOp.updateValueSetVersionable(new URI("VSD:AUTHORING:JUNIT:TEST2"), changedVersionable, revInfo); | |
...
| Scrollbar | ||
|---|---|---|
|
