org.simantics.databoard.accessor.binary
Class BinaryVariant

java.lang.Object
  extended by org.simantics.databoard.accessor.binary.BinaryObject
      extended by org.simantics.databoard.accessor.binary.BinaryVariant
All Implemented Interfaces:
Accessor, CloseableAccessor, FileAccessor, FileVariantAccessor, VariantAccessor

public class BinaryVariant
extends BinaryObject
implements VariantAccessor, FileVariantAccessor


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.simantics.databoard.accessor.Accessor
Accessor.Listener
 
Constructor Summary
BinaryVariant(BinaryObject parent, Blob blob, DataType type)
           
 
Method Summary
 void addListener(Accessor.Listener listener, InterestSet interestSet, AccessorReference path)
          Place a listener to an accessor node.
<T extends Accessor>
T
getAccessor(AccessorReference reference)
          Get an accessor to a sub-container.
 DataType getContentType()
           
 java.lang.Object getContentValue(Binding contentBinding)
           
<T extends Accessor>
T
getValueAccessor()
          Get the value
 void removeListener(Accessor.Listener listener)
          Remove a listener.
 void setContentValue(Binding valueBinding, java.lang.Object value)
          Set the value of this variant.
 void setContentValueNoflush(Binding valueBinding, java.lang.Object value)
           
 void setValueNoflush(Binding variantBinding, java.lang.Object variantValue)
          Write a new value and don't flush the buffer
 VariantType type()
          Get structural represtentation of the accessor presented in databoard's type system format.
 
Methods inherited from class org.simantics.databoard.accessor.binary.BinaryObject
apply, close, createAccessor, file, flush, getBinary, getSource, getValue, setValue, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.simantics.databoard.accessor.file.FileAccessor
close, file, flush
 
Methods inherited from interface org.simantics.databoard.accessor.Accessor
apply, getValue, setValue
 

Constructor Detail

BinaryVariant

public BinaryVariant(BinaryObject parent,
                     Blob blob,
                     DataType type)
Method Detail

type

public VariantType type()
Description copied from interface: Accessor
Get structural represtentation of the accessor presented in databoard's type system format.

Specified by:
type in interface Accessor
Specified by:
type in interface VariantAccessor
Overrides:
type in class BinaryObject
Returns:
type description

getValueAccessor

public <T extends Accessor> T getValueAccessor()
                                    throws AccessorConstructionException
Description copied from interface: VariantAccessor
Get the value

Specified by:
getValueAccessor in interface VariantAccessor
Returns:
value
Throws:
AccessorConstructionException

setContentValueNoflush

public void setContentValueNoflush(Binding valueBinding,
                                   java.lang.Object value)
                            throws AccessorException
Specified by:
setContentValueNoflush in interface FileVariantAccessor
Throws:
AccessorException

setContentValue

public void setContentValue(Binding valueBinding,
                            java.lang.Object value)
                     throws AccessorException
Description copied from interface: VariantAccessor
Set the value of this variant. (Note! this methods sets the _content_ value, in contrast to Accessor.setValue(org.simantics.databoard.binding.Binding, Object) which sets the _variant_ value.

Specified by:
setContentValue in interface VariantAccessor
Throws:
AccessorException

getContentType

public DataType getContentType()
                        throws AccessorException
Specified by:
getContentType in interface VariantAccessor
Throws:
AccessorException

getContentValue

public java.lang.Object getContentValue(Binding contentBinding)
                                 throws AccessorException
Specified by:
getContentValue in interface VariantAccessor
Throws:
AccessorException

getAccessor

public <T extends Accessor> T getAccessor(AccessorReference reference)
                               throws AccessorConstructionException
Description copied from interface: Accessor
Get an accessor to a sub-container. If one already exists, the same is returned, otherwise a new is created.

InvalidatedEvent is thrown from the accessor if it is unlinked from the parent hierarchy.

Specified by:
getAccessor in interface Accessor
Parameters:
reference - component reference or null to return _this_ accessor
Returns:
accessor
Throws:
AccessorConstructionException

addListener

public void addListener(Accessor.Listener listener,
                        InterestSet interestSet,
                        AccessorReference path)
                 throws AccessorException
Description copied from interface: Accessor
Place a listener to an accessor node. The listener will be notified for changes in the node or posssibly its decendant nodes, depending on interest set.

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.

Specified by:
addListener in interface Accessor
Overrides:
addListener in class BinaryObject
path - path to the accessor or null. This is used in the events the accessor produces
Throws:
AccessorException
See Also:
collects events

removeListener

public void removeListener(Accessor.Listener listener)
                    throws AccessorException
Description copied from interface: Accessor
Remove a listener. If the listener is added multiple times, the last one added is removed.

Specified by:
removeListener in interface Accessor
Overrides:
removeListener in class BinaryObject
Throws:
AccessorException

setValueNoflush

public void setValueNoflush(Binding variantBinding,
                            java.lang.Object variantValue)
                     throws AccessorException
Description copied from class: BinaryObject
Write a new value and don't flush the buffer

Specified by:
setValueNoflush in interface FileAccessor
Specified by:
setValueNoflush in class BinaryObject
Throws:
AccessorException