AutocompleteWire extends Wire

An AutocompleteWire specifies that a target VisibleThing should support data entry through autocompletion from the source DomainIterator, as specified by a matching DomainAttribute.

An AutocompleteWire is a unidirectional Wire, that connects a DomainIterator to a VisibleThing (the target element). An AutocompleteWire has an additional reference, match, which references a DomainAttribute from which to search by. The connected DomainType for that iterator must have a DomainAttribute matching the name of the target element, as this will be the value used for a successful autocomplete interaction.

IAML does not specify whether the search should be performed on the client or the server. For small data sets, the database could be prefetched and cached by the client, in order to perform quick searches; for larger data sets, the database should remain on the server, and the search performed asynchronously.

[AutocompleteWire.html]

Examples

AutocompleteWireSimple.iaml (source)
- Using an AutocompleteWire to allow the search fore-mail addresses using a separate DomainAttribute for searching. [AutocompleteWireSimple]

Inference Rules

An AutocompleteWire connected to a DomainIterator will automatically override the query of the Iterator based on what the wire matches. [autocomplete-wires]
An AutocompleteWire, connecting an DomainIterator to a VisibleThing, will also create a query InputTextField to accept user input, which will be used to search the DomainIterator. [autocomplete-wires]
An AutocompleteWire, connecting an DomainIterator to a VisibleThing, will populate the containing Frame with an InputForm to contain autocompleted results. [autocomplete-wires]
If the query InputTextField for an AutocompleteWire is empty, accessing the containing Frame will hide the results IteratorList. [autocomplete-wires]
If the query InputTextField for an AutocompleteWire is notEmpty, accessing the containing Frame will show the results IteratorList. [autocomplete-wires]
If the query InputTextField for an AutocompleteWire is changed and empty, the results IteratorList will be hidden. [autocomplete-wires]
If the query InputTextField for an AutocompleteWire is changed and notEmpty, the results IteratorList will be shown. [autocomplete-wires]
The InputForm results container generated by an AutocompleteWire will be populated with a results IteratorList to display matched results in a list, using a SetWire. [autocomplete-wires]
Every Label within the results IteratorList of an AutocompleteWire search will be provided an ECARule to update a target element -- where the name of the DomainAttributeInstance matches the name of the target VisibleThing -- when the Label is clicked. [autocomplete-wires]
The query InputTextField created by an AutocompleteWire will update the field whenever it receives input. [autocomplete-wires]
The query InputTextField created by an AutocompleteWire will be connected as a Parameter to the connected DomainIterator. [autocomplete-wires]
When a matching Label result is clicked from an AutocompleteWire search, the query InputTextField will be cleared to a blank Value. [autocomplete-wires]

Constraints

"An AutocompleteWire should have a 'match' attribute specified" [Checks.chk]
"A Wire must have a 'from'" [Checks.chk] [from Wire]
"A Wire must have a 'to'" [Checks.chk] [from Wire]

Inherited Attributes

generatedRule : EString (optional)
To assist in debugging, this attribute may be populated with the name of the model completion rule that created this element. More extensive traceability support may be provided in the future.
id : EString (optional)
A unique identifier for this model element. Should be globally unique.
isGenerated : EBoolean (optional)
Set to true if the current element has been generated.
name : EString (optional)
A non-unique string that names a given object.
overridden : EBoolean (optional)
If a GeneratesElements is overridden, then this element will not generate any elements directly.
overriddenNames : EString (optional)
When applying model completion, no NamedElements with these names will be generated by this element.

Inherited Children

conditionEdges : [0...*] SimpleCondition
A list of contained SimpleConditions.
constraintEdges : [0...*] ConstraintEdge
A list of contained ConstraintEdges.
ecaRules : [0...*] ECARule
A list of contained ECARules.
extendsEdges : [0...*] ExtendsEdge
A list of contained ExecutionEdges.
parameterEdges : [0...*] Parameter
A list of contained Parameters.
providesEdges : [0...*] ProvidesEdge
A list of contained ProvidesEdges.
requiresEdges : [0...*] RequiresEdge
A list of contained RequiresEdges.
schemaEdges : [0...*] SchemaEdge
A list of contained SchemaEdges.
selectEdges : [0...*] SelectEdge
A list of contained SelectEdges.
wires : [0...*] Wire
A list of contained Wires.

References

match : [0...1] DomainAttribute
This AutocompleteWire will match user input against the string representation of instances of this DomainAttribute.

Inherited References

conditions : [0...*] ComplexTerm [opposite: conditioned]
A list of incoming Conditions that may restrict the behaviour of this element.
from : [1] WireSource [opposite: outWires]
The source of a Wire.
generatedBy : [0...*] GeneratesElements [opposite: generatedElements]
A list of elements that generated this element; conversely, overriding the source will prevent this element from being created.
generatedElements : [0...*] GeneratedElement [opposite: generatedBy]
A list of GeneratedElements that this element has generated through model completion.
inParameterEdges : [0...*] Parameter [opposite: parameterTerm]
A list of incoming Parameters.
to : [1] WireDestination [opposite: inWires]
The target of a Wire.

AutocompleteWire extends Wire

Examples

Inference Rules

Constraints

Attributes

Inherited Attributes

Children

Inherited Children

References

Inherited References

Extensions

Inherited Extensions