SCL Registry - Revision history

Tuukka Lehtonen at 19:42, 6 September 2012

2012-09-06T19:42:56Z

← Older revision		Revision as of 19:42, 6 September 2012
Line 1:		Line 1:
	[[Category: Simantics Constraint Language]]		[[Category: Simantics Constraint Language]]

	This pages documents a mechanism for finding and contributing SCL types and values in Simantics platform. All interfaces and classes mentioned are defined in the plugins org.simantics.scl.types, org.simantics.scl.reflection or org.simantics.scl.runtime.		This pages documents a mechanism for finding and contributing SCL types and values in Simantics platform. All interfaces and classes mentioned are defined in the plugins org.simantics.scl.types, org.simantics.scl.reflection or org.simantics.scl.runtime.

Tuukka Lehtonen at 19:42, 6 September 2012

2012-09-06T19:42:22Z

← Older revision		Revision as of 19:42, 6 September 2012
Line 1:		Line 1:
			[[Category: Simantics Constraint Language]]

	This pages documents a mechanism for finding and contributing SCL types and values in Simantics platform. All interfaces and classes mentioned are defined in the plugins org.simantics.scl.types, org.simantics.scl.reflection or org.simantics.scl.runtime.		This pages documents a mechanism for finding and contributing SCL types and values in Simantics platform. All interfaces and classes mentioned are defined in the plugins org.simantics.scl.types, org.simantics.scl.reflection or org.simantics.scl.runtime.

Hannu Niemisto: /* Contributing types and values */

2011-08-02T14:53:09Z

Contributing types and values

← Older revision		Revision as of 14:53, 2 August 2011
Line 94:		Line 94:
	<dt>import		<dt>import
	<dd>		<dd>
	'''attributes''': path, localName<br/>		'''attributes''': path, localName (optional)<br/>
	Gives a path a localName that can be used to refer it in type declarations.		Gives a path a localName that can be used to refer it in type declarations.
	<dt>externalClass		<dt>externalClass
	<dd>		<dd>
			'''attributes''': className, alternativeName (optional)<br/>
	Contributes a class without annotations.		Contributes a class without annotations.
	<dt>externalMethod		<dt>externalMethod
	<dd>		<dd>
			'''attributes''': className, methodName, alternativeName (optional)<br/>
	Contributes a method without annotations.		Contributes a method without annotations.
	</dl>		</dl>

Hannu Niemisto: /* Contributing types and values */

2011-08-02T14:18:20Z

Contributing types and values

← Older revision		Revision as of 14:18, 2 August 2011
Line 85:		Line 85:
	<dd>		<dd>
	'''attributes''': path<br/>		'''attributes''': path<br/>
	'''possible children''': class, namespace<br/>		'''possible children''': class, namespace, externalClass, externalMethod, import<br/>
	Represents a library or type in semantic graph. If the element is the root of the extension,		Represents a library or type in semantic graph. If the element is the root of the extension,
	path is an absolute uri of the resource. Otherwise it is relative path from its parent element.		path is an absolute uri of the resource. Otherwise it is relative path from its parent element.
Line 92:		Line 92:
	'''attributes''': className<br/>		'''attributes''': className<br/>
	Declares a Java class to be searched for annotations.		Declares a Java class to be searched for annotations.
			<dt>import
			<dd>
			'''attributes''': path, localName<br/>
			Gives a path a localName that can be used to refer it in type declarations.
			<dt>externalClass
			<dd>
			Contributes a class without annotations.
			<dt>externalMethod
			<dd>
			Contributes a method without annotations.
	</dl>		</dl>

Hannu Niemisto: /* Finding values */

2011-08-02T12:58:32Z

Finding values

← Older revision		Revision as of 12:58, 2 August 2011
Line 73:		Line 73:
	=== Finding values ===		=== Finding values ===

	Values are found using <code>ReflectionUtils.getValue</code>. The method requires ~~a type binding scheme,~~ the URI ~~of the value and the expected type~~ of the value. This method does not cache the values.		Values are found using <code>ReflectionUtils.getValue</code>. The method requires the URI of the value. This method does not cache the values.

	== Contributing types and values ==		== Contributing types and values ==

Hannu Niemisto at 11:20, 2 August 2011

2011-08-02T11:20:21Z

← Older revision		Revision as of 11:20, 2 August 2011
Line 66:		Line 66:
	String --> String		String --> String
	</pre>		</pre>

	~~=== Contributing type constructors ===~~

	~~Type constructors are contributed using the extension point described in the next section.~~

	== Values ==		== Values ==
Line 79:		Line 75:
	Values are found using <code>ReflectionUtils.getValue</code>. The method requires a type binding scheme, the URI of the value and the expected type of the value. This method does not cache the values.		Values are found using <code>ReflectionUtils.getValue</code>. The method requires a type binding scheme, the URI of the value and the expected type of the value. This method does not cache the values.

	=== Contributing values ===		== Contributing types and values ==

	~~Values~~ are ~~contributing using the extension point <code>org.simantics.scl.reflection.binding</code>. Instance method~~, ~~class~~ methods, ~~constructors and static fields~~ can be ~~contributed~~.		Type are contributed putting SCLType-annotations to classes and values with SCLValue-annotations on fields, constructors and methods. Both annotations have an optioinal name-attribute, which can be used to override the default name that is the name of the class or method annotated. SCLValue -annotation has also a required type-annotation where the SCL type of the value must be declared.

	~~When a method or constructor is contributed~~, ~~it is made available as a Function~~.		In addition, classes containing these annotations must be declared using the extension point <code>org.simantics.scl.reflection.binding</code>. It has the following elements

	<dl>		<dl>
	<dt>~~library~~		<dt>namespace
	<dd>		<dd>
	'''attributes''': path<br/>		'''attributes''': path<br/>
	'''possible children''': ~~library~~, ~~package, class~~<br/>		'''possible children''': class, namespace<br/>
	Represents a library or type in semantic graph. If the element is the root of the extension,		Represents a library or type in semantic graph. If the element is the root of the extension,
	path is an absolute uri of the resource. Otherwise it is relative path from its parent element.		path is an absolute uri of the resource. Otherwise it is relative path from its parent element.
	~~<dt>package~~
	~~<dd>~~
	~~'''attributes''': name<br/>~~
	~~Binds a Java package with given name to the parent library. The constructors of all classes in the package are made available as values.~~
	<dt>class		<dt>class
	<dd>		<dd>
	'''attributes''': ~~name~~<br/>		'''attributes''': className<br/>
	~~Binds~~ a Java class ~~with given name~~ to ~~the parent library. Public fields and methods of the class are made available as values~~.		Declares a Java class to be searched for annotations.
	</dl>		</dl>

	~~'''TODO''': how SCL types are contributed~~

Hannu Niemisto: /* Finding values */

2011-08-02T06:42:46Z

Finding values

← Older revision		Revision as of 06:42, 2 August 2011
Line 77:		Line 77:
	=== Finding values ===		=== Finding values ===

	Values are found using <code>~~ReflectoinUtils~~.getValue</code>. The method requires a type binding scheme, the URI of the value and the expected type of the value. This method does not cache the values.		Values are found using <code>ReflectionUtils.getValue</code>. The method requires a type binding scheme, the URI of the value and the expected type of the value. This method does not cache the values.

	=== Contributing values ===		=== Contributing values ===

Hannu Niemisto at 06:42, 2 August 2011

2011-08-02T06:42:15Z

← Older revision		Revision as of 06:42, 2 August 2011
Line 102:		Line 102:
	</dl>		</dl>

	~~<bf>~~TODO~~</bf>~~: how SCL types are contributed		'''TODO''': how SCL types are contributed

Hannu Niemisto: /* Contributing values */

2011-08-02T06:42:01Z

Contributing values

← Older revision		Revision as of 06:42, 2 August 2011
Line 101:		Line 101:
	Binds a Java class with given name to the parent library. Public fields and methods of the class are made available as values.		Binds a Java class with given name to the parent library. Public fields and methods of the class are made available as values.
	</dl>		</dl>

			<bf>TODO</bf>: how SCL types are contributed

Hannu Niemisto: /* Values */

2011-08-02T06:41:28Z

Values

← Older revision		Revision as of 06:41, 2 August 2011
Line 74:		Line 74:

	The type conversion rules in the previous section already dictate the Java class of the values of a certain SCL type. Depending on the type constructor, there are additional constraints. For example, values of type <code>[a]</code> must implement interface <code>java.util.List</code> and additionally elements of the list must be compatible with a. Values of type <code>a -> b</code> must implement the interface <code>Function</code> and additionally when method <code>apply</code> is called with a parameter compatible with type <code>a</code> the method must return a value compatible with type <code>b</code>.		The type conversion rules in the previous section already dictate the Java class of the values of a certain SCL type. Depending on the type constructor, there are additional constraints. For example, values of type <code>[a]</code> must implement interface <code>java.util.List</code> and additionally elements of the list must be compatible with a. Values of type <code>a -> b</code> must implement the interface <code>Function</code> and additionally when method <code>apply</code> is called with a parameter compatible with type <code>a</code> the method must return a value compatible with type <code>b</code>.

			=== Finding values ===

			Values are found using <code>ReflectoinUtils.getValue</code>. The method requires a type binding scheme, the URI of the value and the expected type of the value. This method does not cache the values.

	=== Contributing values ===		=== Contributing values ===