Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.databoard / src / org / simantics / databoard / accessor / ArrayAccessor.java

diff --git a/bundles/org.simantics.databoard/src/org/simantics/databoard/accessor/ArrayAccessor.java b/bundles/org.simantics.databoard/src/org/simantics/databoard/accessor/ArrayAccessor.java
new file mode 100644 (file)
index 0000000..df300fb
--- /dev/null
+++ b/bundles/org.simantics.databoard/src/org/simantics/databoard/accessor/ArrayAccessor.java
@@ -0,0 +1,184 @@
+/*******************************************************************************\r
+ *  Copyright (c) 2010 Association for Decentralized Information Management in\r
+ *  Industry THTH ry.\r
+ *  All rights reserved. This program and the accompanying materials\r
+ *  are made available under the terms of the Eclipse Public License v1.0\r
+ *  which accompanies this distribution, and is available at\r
+ *  http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ *  Contributors:\r
+ *      VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.databoard.accessor;
+
+import java.util.Collection;\r
+\r
+import org.simantics.databoard.accessor.error.AccessorConstructionException;\r
+import org.simantics.databoard.accessor.error.AccessorException;\r
+import org.simantics.databoard.binding.Binding;\r
+import org.simantics.databoard.binding.error.BindingException;\r
+import org.simantics.databoard.type.ArrayType;\r
+
+public interface ArrayAccessor extends Accessor {
+
+       /**
+        * Add a new value. 
+        * 
+        * @param binding
+        * @param value value
+        * @throws AccessorException
+        */
+       void add(Binding binding, Object value) throws AccessorException;
+
+       /**
+        * Add an array of elements.
+        * 
+        * @param binding
+        * @param values value 
+        * @throws AccessorException
+        */
+       void addAll(Binding binding, Object[] values) throws AccessorException;
+       
+       /**
+        * Add an array of elements.  
+        * 
+        * If elements are inserted in the middle of the array, existing interest sets
+        * are updated to reflect the new positions. 
+        * 
+        * @param index position to insert new value to
+        * @param binding
+        * @param values
+        * @throws AccessorException
+        */
+       void addAll(int index, Binding binding, Object[] values) throws AccessorException;
+       
+       /**
+        * Insert a new value.
+        * 
+        * If elements are inserted in the middle of the array, existing interest sets
+        * are updated to reflect the new positions. 
+        * 
+        * @param index position to insert new value to
+        * @param binding
+        * @param value value
+        * @throws AccessorException
+        */
+       void add(int index, Binding binding, Object value) throws AccessorException;
+       
+       /**
+        * Set all elements from an Array Value.
+        * 
+        * If array becomes shorter and there are accessors to the removed elements,
+        * the accessors are invalidated. 
+        * 
+        * @param binding
+        * @param newValue
+        * @throws BindingException binding error
+        * @throws UnsupportedOperationException cannot set a new value
+        */
+       void setValue(Binding binding, Object newValue) throws AccessorException;
+       
+       /**
+        * Replace a value container with a new value.
+        * 
+        * @param index
+        * @param binding
+        * @param value
+        * @throws AccessorException
+        */
+       void set(int index, Binding binding, Object value) throws AccessorException;
+       
+       /**
+        * Remove an element at an index.
+        *  
+        * If there are listeners to elements after the <code>index</code>, the 
+        * interest sets and accessor paths are updated and decreased.    
+        * 
+        * If there was an accessor, it becomes invalid.
+        * 
+        * @param index
+        * @param count
+        * @throws AccessorException
+        */
+       void remove(int index, int count) throws AccessorException;
+       
+       /**
+        * Get an accessor to an element. 
+        * The accessor is invalidated if the element is removed from the array.
+        * <p>
+        * The accessor is not to the index, it is to the element. For instance, you get accessor X of [2]
+        * then a new value is inserted before 2. The accessor now points to the element at [3].   
+        * 
+        * @param index
+        * @return the accessor
+        * @throws AccessorConstructionException
+        */
+       <T extends Accessor> T getAccessor(int index) throws AccessorConstructionException;
+       
+       /**\r
+        * Get a copy of the element \r
+        * \r
+        * @param index\r
+        * @param valueBinding\r
+        * @return the element\r
+        * @throws AccessorException\r
+        */\r
+       Object get(int index, Binding valueBinding) throws AccessorException;\r
+       \r
+       /**\r
+        * Read the element to an object\r
+        * \r
+        * @param index\r
+        * @param valueBinding\r
+        * @param dest\r
+        * @throws AccessorException\r
+        */\r
+       void get(int index, Binding valueBinding, Object dest) throws AccessorException;\r
+       \r
+       /**
+        * Get all elements and place them to an <code>array</code>. 
+        * Exception is thrown if Array length is too short. 
+        * 
+        * @param valueBinding
+        * @param array 
+        * @throws AccessorException
+        */
+       void getAll(Binding valueBinding, Object[] array) throws AccessorException;
+       
+       /**
+        * Get all elements
+        * 
+        * @param valueBinding
+        * @param values
+        * @throws AccessorException
+        */
+       void getAll(Binding valueBinding, Collection<Object> values) throws AccessorException;\r
+       \r
+//     /**
+//      * Get a partial array 
+//      * 
+//      * @param binding
+//      * @param index
+//      * @param count
+//      * @return array
+//      * @throws AccessorException
+//      */
+//     Object getPartial(ArrayBinding binding, int index, int count) throws AccessorException;
+       \r
+       void setSize(int newSize) throws AccessorException;\r
+       
+       /**
+        * Return the number of elements in the array.
+        * 
+        * @return the number of elements
+        * @throws AccessorException
+        */
+       int size() throws AccessorException;    
+       
+       ArrayType type();
+\r
+       public interface CloseableArrayAccessor extends ArrayAccessor, CloseableAccessor {}\r
+       
+}\r
+\r
+