|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.simantics.databoard.accessor.java.JavaObject
org.simantics.databoard.accessor.java.JavaRecord
public class JavaRecord
Accessor to a Java Object of Record Type.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.simantics.databoard.accessor.Accessor |
---|
Accessor.Listener |
Constructor Summary | |
---|---|
JavaRecord(JavaObject parent,
RecordBinding binding,
java.lang.Object object)
|
Method Summary | ||
---|---|---|
void |
addListener(Accessor.Listener listener,
InterestSet interestSet,
AccessorReference path)
Place a listener to an accessor node. |
|
int |
count()
Get the number of fields in the record |
|
|
getAccessor(AccessorReference reference)
Get an accessor to a sub-container. |
|
RecordBinding |
getBinding()
|
|
|
getFieldAccessor(int index)
Get an accessor to a field. |
|
|
getFieldAccessor(java.lang.String fieldName)
Get an accessor to a field. |
|
java.lang.Object |
getFieldValue(int index,
Binding fieldBinding)
Get field value |
|
void |
removeListener(Accessor.Listener listener)
Remove a listener. |
|
void |
setFieldValue(int index,
Binding binding,
java.lang.Object value)
Set field value. |
|
void |
setValue(Binding binding,
java.lang.Object newValue)
Set a complete new value to the data container. |
|
RecordType |
type()
Get structural represtentation of the accessor presented in databoard's type system format. |
Methods inherited from class org.simantics.databoard.accessor.java.JavaObject |
---|
apply, createAccessor, getObject, getValue, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.simantics.databoard.accessor.Accessor |
---|
apply, getValue |
Constructor Detail |
---|
public JavaRecord(JavaObject parent, RecordBinding binding, java.lang.Object object) throws AccessorConstructionException
AccessorConstructionException
Method Detail |
---|
public RecordBinding getBinding()
getBinding
in class JavaObject
public RecordType type()
Accessor
type
in interface Accessor
type
in interface RecordAccessor
type
in class JavaObject
public int count()
RecordAccessor
count
in interface RecordAccessor
public <T extends Accessor> T getFieldAccessor(java.lang.String fieldName) throws AccessorConstructionException
RecordAccessor
RecordAccessor.setFieldValue(int, Binding, Object)
.
getFieldAccessor
in interface RecordAccessor
AccessorConstructionException
public <T extends Accessor> T getFieldAccessor(int index) throws AccessorConstructionException
RecordAccessor
RecordAccessor.setFieldValue(int, Binding, Object)
.
getFieldAccessor
in interface RecordAccessor
AccessorConstructionException
public java.lang.Object getFieldValue(int index, Binding fieldBinding) throws AccessorException
RecordAccessor
getFieldValue
in interface RecordAccessor
AccessorException
public void setFieldValue(int index, Binding binding, java.lang.Object value) throws AccessorException
RecordAccessor
setFieldValue
in interface RecordAccessor
index
- field index
AccessorException
public void addListener(Accessor.Listener listener, InterestSet interestSet, AccessorReference path) throws AccessorException
Accessor
The synchronization contract is implementation specific, so read the document. A common contract is that the listener object must not make modifications to the accessor within the handle event function. The correct strategy is to collect events and mutate the accessor afterwards.
Each event instance spawned by the listener, is annotated with a reference that describes the reference path of the node to which the event applies to. The path originates from the node where the listener was placed.
Listener is attached to the container that holds the value at the time at the of the adding. For example, If a listener is attached to an array of element at index 3, and a new value is inserted at position 2, the listener still monitors the same container, which is now at index 4. The references of incoming the events are modified to have the new index.
Also, if a new value is assigned to the parent of an object that is listened, the listener keeps on monitoring the new value at the same reference. This doesn't apply when a new value is set to a union of different tag, to a variant with a new type, or value is removed from Optional type. In these two cases the listener is invalidated.
See ChangeSet
is an implementation that collects events.
addListener
in interface Accessor
addListener
in class JavaObject
path
- path to the accessor or null
. This is used in the events the accessor produces
AccessorException
collects events
public void removeListener(Accessor.Listener listener) throws AccessorException
Accessor
removeListener
in interface Accessor
removeListener
in class JavaObject
AccessorException
public <T extends Accessor> T getAccessor(AccessorReference reference) throws AccessorConstructionException
Accessor
InvalidatedEvent is thrown from the accessor if it is unlinked from the parent hierarchy.
getAccessor
in interface Accessor
reference
- component reference or null
to return _this_ accessor
AccessorConstructionException
public void setValue(Binding binding, java.lang.Object newValue) throws AccessorException
Accessor
InvalidatedEvent
. Writing the current value again may not emit an event. This is implementation specific.
Write is durable, once a the method returns successfully the value has been stored in the implmentation.
setValue
in interface Accessor
AccessorException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |