Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.databoard / src / org / simantics / databoard / type / OptionalType.java

diff --git a/bundles/org.simantics.databoard/src/org/simantics/databoard/type/OptionalType.java b/bundles/org.simantics.databoard/src/org/simantics/databoard/type/OptionalType.java
new file mode 100644 (file)
index 0000000..d704e86
--- /dev/null
+++ b/bundles/org.simantics.databoard/src/org/simantics/databoard/type/OptionalType.java
@@ -0,0 +1,109 @@
+/*******************************************************************************\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.type;
+
+import java.util.Set;\r
+\r
+import org.simantics.databoard.accessor.error.ReferenceException;\r
+import org.simantics.databoard.accessor.reference.ChildReference;\r
+import org.simantics.databoard.accessor.reference.ComponentReference;\r
+import org.simantics.databoard.accessor.reference.IndexReference;\r
+import org.simantics.databoard.accessor.reference.KeyReference;\r
+import org.simantics.databoard.accessor.reference.LabelReference;\r
+import org.simantics.databoard.accessor.reference.NameReference;\r
+import org.simantics.databoard.util.IdentityPair;\r
+
+public class OptionalType extends Datatype {
+    public Datatype componentType;
+    
+    public OptionalType() {            
+    }
+    
+    public OptionalType(Datatype componentType) {
+       this.componentType = componentType;
+    }
+    
+    public Datatype getComponentType() {
+       return componentType;
+    }\r
+    \r
+    @Override\r
+    public int getComponentCount() {\r
+       return 1;\r
+    }\r
+    \r
+    @Override\r
+    public Datatype getComponentType(int index) {\r
+       if (index!=0) throw new IllegalArgumentException();\r
+       return componentType;\r
+    }\r
+    \r
+    @Override\r
+    public Datatype getComponentType(ChildReference path) {\r
+       if (path==null) return this;\r
+       if (path instanceof KeyReference) throw new IllegalArgumentException("KeyReference is not supported in OptionalType"); \r
+       if (path instanceof NameReference) throw new IllegalArgumentException("NameReference is not supported in OptionalType"); \r
+       if (path instanceof IndexReference && ((IndexReference) path).index!=0) throw new IllegalArgumentException("Index out of bounds");\r
+       if (path instanceof LabelReference && !((LabelReference) path).label.equals("v")) throw new IllegalArgumentException("Unknown label");\r
+       return componentType.getComponentType(path.childReference);\r
+    }    
+    
+       @Override
+       protected void collectSubtypes(Set<Datatype> subtypes,
+               Set<Datatype> recursiveSubtypes) {
+               componentType.collectSubtypes(subtypes, recursiveSubtypes);
+       }
+    
+    @Override\r
+    public int hashCode() {\r
+       return componentType.hashCode() + metadataHashCode();\r
+    }\r
+    \r
+    @Override
+    protected boolean deepEquals(Object obj, Set<IdentityPair<Datatype, Datatype>> compareHistory) {
+               if (this==obj) return true;\r
+               if (obj instanceof OptionalType == false) return false;\r
+               if ( !hasEqualMetadata(obj) ) return false;\r
+               OptionalType other = (OptionalType) obj;
+               return componentType.deepEquals(other.componentType, compareHistory);
+    }     
+
+       @Override
+       public void accept(Visitor1 v, Object obj) {
+           v.visit(this, obj);        
+       }
+
+       @Override
+       public <T> T accept(Visitor<T> v) {
+           return v.visit(this);
+       }       
+\r
+       @SuppressWarnings("unchecked")\r
+       @Override\r
+       public <T extends Datatype> T getChildType(ChildReference reference) throws ReferenceException {\r
+               if (reference==null) return (T) this;\r
+\r
+               if (reference instanceof LabelReference) {\r
+                       LabelReference lr = (LabelReference) reference;\r
+                       if (lr.label.equals("o")) {\r
+                               return componentType.getChildType(reference.getChildReference());\r
+                       }                       \r
+               }\r
+               \r
+               if (reference instanceof ComponentReference) {\r
+                       return componentType.getChildType(reference.getChildReference());\r
+               } \r
+               \r
+               throw new ReferenceException(reference.getClass()+" is not a reference of OptionalType");               \r
+       }\r
+       
+}