-=Adapter=\r
-There can be different Java Class Bindings for a single data type. For example, <code>Double</code> type can be have bindings <code>DoubleJavaBinding</code> and <code>MutableDoubleBinding</code> to two respective classes <code>java.lang.Double</code> and <code>MutableDouble</code>. Instance of one binding can be adapted to instance of another with an <code>[../javadoc/org/simantics/databoard/adapter/Adapter.html|Adapter]</code>.\r
-\r
-Adapter can be created automatically or implemented self.\r
-<pre class="code">\r
- Adapter adapter = new Adapter() { ... };\r
- Adapter adapter = Bindings.getAdapter( domainBinding, rangeBinding );\r
-</pre>\r
-\r
-Example:\r
-<pre class="code">\r
- Adapter adapter = Bindings.getAdapter(Bindings.MUTABLE_DOUBLE, Bindings.DOUBLE);\r
- java.lang.Double double = adapter.adapt( new MutableDouble(5.0) );\r
-</pre>\r
-\r
-There is also convenience.\r
-<pre class="code">\r
- java.lang.Double double = Bindings.adapt( new MutableDouble(5.0), Bindings.MUTABLE_DOUBLE, Bindings.DOUBLE );\r
-</pre>\r
-\r
-The argument given to <code>Adapter#adapt(Object)</code> may be re-used in the result unless the adapter is a cloning adapter which guarantees a clone. Note, even wih cloning adapters immutable classes, (eg java.lang.Integer) are never cloned.\r
-<pre class="code">\r
- Adapter cloner = Bindings.adapterCache.getAdapter(domain, range, false, true);\r
- cloner.adapt( ... );\r
-\r
- Rectangle2D rect2 = Bindings.clone( rect1, rectBinding, rectBinding );\r
-</pre>\r
-\r
-==Type Conversion==\r
-In some cases different types may be are type-conversion compatible. An instance of one type is convertible to instance of another.\r
-\r
-'''Engineering Units of same quantity are convertible.'''\r
-<pre class="code">\r
- class CarSI {\r
- String modelName; \r
- @Unit("km/h") double maxVelocity; \r
- @Unit("kg") double mass; \r
- @Unit("cm") double length; \r
- @Unit("kW") double power;\r
- }\r
- \r
- class CarIm {\r
- String modelName; \r
- @Unit("mph") float maxVelocity; \r
- @Unit("lbs") float mass; \r
- @Unit("ft") float length; \r
- @Unit("hp(M)") float power;\r
- }\r
- \r
- Adapter si2imAdapter = Bindings.getTypeAdapter(\r
- Bindings.getBinding(CarSI.class), \r
- Bindings.getBinding(CarIm.class) );\r
- \r
- CarIm americanCarInfo = si2imAdapter.adapt( europeanCarInfo );\r
-</pre>\r
-\r
-'''Primitive Types.''' Note, primitive adapter throws an exception at runtime if values are not adaptable.\r
-<pre class="code">\r
- Adapter adapter = getTypeAdapter( integerBinding, doubleBinding );\r
- Double double = adapter.adapt( new Integer( 5 ) );\r
-</pre>\r
-\r
-'''Records are matched by field names.'''\r
-<pre class="code">\r
- class Foo {\r
- int x, y, z;\r
- }\r
- class Bar {\r
- int z, y, x;\r
- }\r
- Adapter adapter = getTypeAdapter( fooBinding, barBinding );\r
-</pre> \r
-\r
-'''Subtype to supertype:''' Note, this conversion cannot be not symmetric, supertypes cannot be converted to subtypes.\r
-<pre class="code">\r
- class Node {\r
- String id;\r
- }\r
- class ValueNode extends Node {\r
- Object value;\r
- }\r
- Adapter adapter = getTypeAdapter( valueNodeBinding, nodeBinding );\r
-</pre>\r
-\r
-'''Non-existing fields to Optional fields'''\r
-<pre class="code"> \r
- class Node {\r
- String id;\r
- }\r
- class NominalNode {\r
- String id;\r
- @Optional String name;\r
- }\r
- Adapter adapter = getTypeAdapter( nodeBinding, nominalNodeBinding );\r
-</pre> \r
-\r
-'''Enumerations'''\r
-<pre class="code">\r
- enum Cars { Audio, BMW, Mercedes, Honda, Mazda, Toyota, Ford, Mitsubishi, Nissan, GM }\r
- enum JapaneseCars { Honda, Mazda, Toyota, Nissan, Mitsubishi }\r
- \r
- Binding carsBinding = Bindings.getBinding( Cars.class );\r
- Binding japaneseCarsBinding = Bindings.getBinding( JapaneseCars.class );\r
- Adapter adapter = Bindings.adapterCache.getAdapter(japaneseCarsBinding, carsBinding, true, false);\r
+=Adapter=
+There can be different Java Class Bindings for a single data type. For example, <code>Double</code> type can be have bindings <code>DoubleJavaBinding</code> and <code>MutableDoubleBinding</code> to two respective classes <code>java.lang.Double</code> and <code>MutableDouble</code>. Instance of one binding can be adapted to instance of another with an <code>[../javadoc/org/simantics/databoard/adapter/Adapter.html|Adapter]</code>.
+
+Adapter can be created automatically or implemented self.
+<pre class="code">
+ Adapter adapter = new Adapter() { ... };
+ Adapter adapter = Bindings.getAdapter( domainBinding, rangeBinding );
+</pre>
+
+Example:
+<pre class="code">
+ Adapter adapter = Bindings.getAdapter(Bindings.MUTABLE_DOUBLE, Bindings.DOUBLE);
+ java.lang.Double double = adapter.adapt( new MutableDouble(5.0) );
+</pre>
+
+There is also convenience.
+<pre class="code">
+ java.lang.Double double = Bindings.adapt( new MutableDouble(5.0), Bindings.MUTABLE_DOUBLE, Bindings.DOUBLE );
+</pre>
+
+The argument given to <code>Adapter#adapt(Object)</code> may be re-used in the result unless the adapter is a cloning adapter which guarantees a clone. Note, even wih cloning adapters immutable classes, (eg java.lang.Integer) are never cloned.
+<pre class="code">
+ Adapter cloner = Bindings.adapterCache.getAdapter(domain, range, false, true);
+ cloner.adapt( ... );
+
+ Rectangle2D rect2 = Bindings.clone( rect1, rectBinding, rectBinding );
+</pre>
+
+==Type Conversion==
+In some cases different types may be are type-conversion compatible. An instance of one type is convertible to instance of another.
+
+'''Engineering Units of same quantity are convertible.'''
+<pre class="code">
+ class CarSI {
+ String modelName;
+ @Unit("km/h") double maxVelocity;
+ @Unit("kg") double mass;
+ @Unit("cm") double length;
+ @Unit("kW") double power;
+ }
+
+ class CarIm {
+ String modelName;
+ @Unit("mph") float maxVelocity;
+ @Unit("lbs") float mass;
+ @Unit("ft") float length;
+ @Unit("hp(M)") float power;
+ }
+
+ Adapter si2imAdapter = Bindings.getTypeAdapter(
+ Bindings.getBinding(CarSI.class),
+ Bindings.getBinding(CarIm.class) );
+
+ CarIm americanCarInfo = si2imAdapter.adapt( europeanCarInfo );
+</pre>
+
+'''Primitive Types.''' Note, primitive adapter throws an exception at runtime if values are not adaptable.
+<pre class="code">
+ Adapter adapter = getTypeAdapter( integerBinding, doubleBinding );
+ Double double = adapter.adapt( new Integer( 5 ) );
+</pre>
+
+'''Records are matched by field names.'''
+<pre class="code">
+ class Foo {
+ int x, y, z;
+ }
+ class Bar {
+ int z, y, x;
+ }
+ Adapter adapter = getTypeAdapter( fooBinding, barBinding );
+</pre>
+
+'''Subtype to supertype:''' Note, this conversion cannot be not symmetric, supertypes cannot be converted to subtypes.
+<pre class="code">
+ class Node {
+ String id;
+ }
+ class ValueNode extends Node {
+ Object value;
+ }
+ Adapter adapter = getTypeAdapter( valueNodeBinding, nodeBinding );
+</pre>
+
+'''Non-existing fields to Optional fields'''
+<pre class="code">
+ class Node {
+ String id;
+ }
+ class NominalNode {
+ String id;
+ @Optional String name;
+ }
+ Adapter adapter = getTypeAdapter( nodeBinding, nominalNodeBinding );
+</pre>
+
+'''Enumerations'''
+<pre class="code">
+ enum Cars { Audio, BMW, Mercedes, Honda, Mazda, Toyota, Ford, Mitsubishi, Nissan, GM }
+ enum JapaneseCars { Honda, Mazda, Toyota, Nissan, Mitsubishi }
+
+ Binding carsBinding = Bindings.getBinding( Cars.class );
+ Binding japaneseCarsBinding = Bindings.getBinding( JapaneseCars.class );
+ Adapter adapter = Bindings.adapterCache.getAdapter(japaneseCarsBinding, carsBinding, true, false);
</pre>
\ No newline at end of file
Code Review / simantics / platform.git / blobdiff