bundles/org.simantics.databoard/src/org/simantics/databoard/binding/impl/StringArrayBinding.java

   1 /*******************************************************************************
   2  *  Copyright (c) 2010 Association for Decentralized Information Management in
   3  *  Industry THTH ry.
   4  *  All rights reserved. This program and the accompanying materials
   5  *  are made available under the terms of the Eclipse Public License v1.0
   6  *  which accompanies this distribution, and is available at
   7  *  http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  *  Contributors:
  10  *      VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.databoard.binding.impl;
  13
  14 import java.lang.reflect.Array;
  15 import java.util.IdentityHashMap;
  16 import java.util.Iterator;
  17 import java.util.Set;
  18
  19 import org.simantics.databoard.binding.ArrayBinding;
  20 import org.simantics.databoard.binding.Binding;
  21 import org.simantics.databoard.binding.StringBinding;
  22 import org.simantics.databoard.binding.error.BindingException;
  23 import org.simantics.databoard.binding.error.UnsupportedOperationException;
  24 import org.simantics.databoard.type.ArrayType;
  25 import org.simantics.databoard.type.StringType;
  26 import org.simantics.databoard.util.IdentityPair;
  27
  28 /**
  29  * Binds String[] type to String[] class.
  30  */
  31 public final class StringArrayBinding extends ArrayBinding {
  32
  33         public static StringArrayBinding createFrom(ArrayType type)
  34         {
  35                 return new StringArrayBinding(type, new StringBindingDefault((StringType) type.componentType));
  36         }
  37
  38         public StringArrayBinding(ArrayType type, Binding componentBinding)
  39         {
  40                 super(type, componentBinding);
  41         }
  42
  43         @Override
  44         public Object create() {
  45                 return new String[0];
  46         }
  47
  48         @Override
  49         public Object create(int length, Iterator<Object> values) {
  50                 String[] array = new String[length];
  51                 for(int i=0;i<length;++i)
  52                         array[i] = (String)values.next();
  53                 return array;
  54         }
  55
  56         @Override
  57         public void readFrom(Binding srcBinding, Object src, Object dst)
  58                         throws BindingException {
  59                 // Src Binding
  60                 ArrayBinding sb = (ArrayBinding) srcBinding;
  61                 // Src Component Binding
  62                 StringBinding scb = (StringBinding) sb.getComponentBinding();
  63
  64                 String[] d = (String[]) dst;
  65                 if (d.length != sb.size(src)) throw new BindingException("String[] is length immutable");
  66
  67                 for (int i=0; i<d.length; i++) {
  68                         d[i] = scb.getValue( sb.get(src, i) );
  69                 }
  70         }
  71
  72         /**
  73          * Create an array object.
  74          * Note! The argument is consumed (is used in the result).
  75          *
  76          * @param array
  77          * @return an object that contains the array
  78          */
  79         public Object create(String[] array) {
  80                 return array.clone();
  81         }
  82
  83         public Object create(Object[] values) {
  84                 String[] result = new String[values.length];
  85                 for (int i=0; i<values.length; i++)
  86                         result[i] = (String) values[i];
  87                 return result;
  88         }
  89
  90
  91         @Override
  92         public Object get(Object array, int index) throws BindingException {
  93                 if (!isInstance(array)) throw new BindingException("Unexpected class "+array.getClass().getSimpleName()+", String[] expected");
  94                 return ((String[])array)[index];
  95         }
  96
  97         @Override
  98         public void getAll(Object array, Object[] result) throws BindingException {
  99                 String[] a = (String[])array;
 100                 for (int i=0; i<a.length; i++)
 101                         result[i] = a[i];
 102         }
 103
 104         @Override
 105         public void set(Object array, int index, Object value)
 106                         throws BindingException {
 107                 String[] a = (String[])array;
 108                 a[index] = (String) value;
 109         }
 110
 111         @Override
 112         public int size(Object array) throws BindingException {
 113                 if (!isInstance(array)) throw new BindingException("Unexpected class "+array.getClass().getSimpleName()+", String[] expected");
 114                 return ((String[])array).length;
 115         }
 116
 117         @Override
 118         public boolean isInstance(Object obj) {
 119                 return obj instanceof String[];
 120         }
 121
 122         @Override
 123         public boolean isImmutable() {
 124                 return false;
 125         }
 126
 127         public String[] getArray(Object array) throws BindingException {
 128                 if (!isInstance(array)) throw new BindingException("Unexpected class "+array.getClass().getSimpleName()+", String[] expected");
 129                 return (String[]) array;
 130         }
 131
 132     @Override
 133     public int deepHashValue(Object value, IdentityHashMap<Object, Object> hashedObjects) throws BindingException {
 134         int result = 1;
 135         String[] array = (String[]) value;
 136         for (int i=0; i<array.length; i++) {
 137                 String element = array[i];
 138                 result = 31*result + element.hashCode();
 139         }
 140         return result;
 141     }
 142
 143     @Override
 144     public int deepCompare(Object o1, Object o2,
 145                 Set<IdentityPair<Object, Object>> compareHistory)
 146                 throws BindingException {
 147         String[] a1 = (String[]) o1;
 148         String[] a2 = (String[]) o2;
 149                 // Compare Lengths
 150                 int l1 = a1.length;
 151                 int l2 = a2.length;
 152                 int dif = l1 - l2;
 153                 if (dif!=0) return dif;
 154                 // Compare elements
 155                 for (int i=0; i<l1; i++) {
 156                         String v1 = a1[i];
 157                         String v2 = a2[i];
 158                         dif = v1.compareTo(v2);
 159                         if (dif!=0) return dif;
 160                 }
 161                 return 0;
 162     }
 163
 164     @Override
 165     public void add(Object array, int index, Object element)
 166                 throws BindingException, IndexOutOfBoundsException {
 167         throw new UnsupportedOperationException();
 168     }
 169
 170         @Override
 171         public void remove(Object array, int index, int count) throws BindingException {
 172         throw new UnsupportedOperationException();
 173         }
 174
 175         @Override
 176         public void setSize(Object array, int newSize) throws BindingException {
 177                 int oldSize = Array.getLength(array);
 178                 if (oldSize==newSize) return;
 179                 throw new BindingException("String[] is length immutable");
 180         }
 181
 182         @Override
 183         public boolean isResizable() {
 184                 return false;
 185         }
 186
 187 }