Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Org.eclipse.higgins.js.pds.client API usage example
{{#eclipseproject:technology.higgins|eclipse_custom_style.css}}
We show an example of calling getAttributes, calling setAttributes and then calling getAttributes a second time. In all cases we read/write the same two attributes in the nytimes.com namespace, bFirstName and phone.
Contents
Initial State
Contexts
NYTimes template
The template context http://azigo.com/sys/templates/nytimes.com contains (among other things) the following mapping rules:
:NYTimesPerson a owl:Class ; rdfs:subClassOf <http://www.eclipse.org/higgins/ontologies/2010/6/higgins#Person> ;
rule #1:
map:nameRule [ a map:roleSameAs ; map:equivalentAttribute fp:givenName ; map:predicate :bFirstName ; map:role <http://www.eclipse.org/higgins/ontologies/2010/6/persona#Buyer> ] ;
rule #2:
map:telephoneRule [ a map:roleSameAs ; map:equivalentAttribute fp:phone ; map:predicate :phone ; map:role <http://www.eclipse.org/higgins/ontologies/2010/6/persona#Ecommerce> ] .
call getAttributes()
Call
Example call to getAttributes (domain, audience, attributes[], where[], future)
- atts[0] := (http://nytimes#phone, false, nil) // a phone number
- atts[1] := (http://nytimes#bFirstName, false, nil) // "billing first name"
- getAttributes ("nytimes.com", nil, atts, nil, nil)
Execution
- context := getConnectionContext ()
- result: context == http://azigo.com/ptrevithick/nytimes.com)
- call findRoles()
- result:
- ((p:eCommerce, (nytimes.com#bFirstName, nil, nil))
- (p:Buyer, (nytimes.com#phone, nil, nil)))
- result:
- call sortByRole()
- result:
- ((p:eCommerce, (nytimes.com#bFirstName, nil, nil))
- (p:Buyer, (nytimes.com#phone, nil, nil)))
- result:
- Try to pull attributes from #me person in the nytimes.com
- result: no result: the nytimes.com context doesn't yet exist
- Try to pull attributes from #me person in root context
- call findPersonByRole()
- result: nil (no persons found that match role)
- result: no attribute/values found
call setAttributes()
Call
Example call to setAttributes (domain, attributes[])
- atts[0] := (http://nytimes#bFirstName, false, nil) // "billing first name"
- atts[1] := (http://nytimes#phone, false, nil) // a phone number
- setAttributes ("nytimes.com", atts[])
Execution
- context := getConnectionContext ()
- result: context == http://azigo.com/ptrevithick/nytimes.com
- template := getConnectionTemplate ()
- result: template == http://azigo.com/sys/template/nytimes.com
- Since context doesn't exist, create it from template
- newPersonRole := value of role attribute of Participant ContextPrototype
- result: newPersonRole == p:Ecommerce
- attributes[] := extractAttributes ()
- result: attributes[] == (http://nytimes.com#phone, http://nytimes.com#bFirstName)
- rolesAtts[] := findRoles()
- result: rolesAtts[] == ((p:Byer, http://nytimes.com#phone), (p:Ecommerce, http://nytimes.com#bFirstName))
- sortByRole
- result: rolesAtts[] == ((p:Byer, http://nytimes.com#phone), (p:Ecommerce, http://nytimes.com#bFirstName))
- person := http://azigo.com/ptrevithick/nytimes.com#me
- Since person doesn't exist we create the statements:
- (subj=:me pred=rdf:type obj=persona:Person) in context
- (subj=:me pred=p:role obj=(newPersonRole==persona:Ecommerce)) in context
- Loop(0) ra==(p:Ecommerce, http://nytimes.com#phone) // Loop: For every pair ra in rolesAtts..
- targetPersons[] := findPersonsByRole (person, p:Ecommerce)
- result: targetPersons[0] == <:me person created above>; targetPersons[] is of size == 1
- targetPersons[] := findPersonsByRole (person, p:Ecommerce)
- class := getNamespace(http://nytimes.com#bFirstName)
- result: class == http://nytimes.com
- att := getLocalAtt (http://nytimes.com#bFirstName)
- result: att == "bFirstName"
- rule := getRule (template=http://azigo.com/sys/template/nytimes.com, class=http://nytimes.com, att="bFirstName")
- result: rule := (see "rule #1" in Initial State section above)
- newPerson := pushEvalRule (context=http://azigo.com/ptrevithick/nytimes.com, rule, value="Alice")
- result: a new Person node named "#me" ...
- class := getNamespace(http://nytimes.com#bFirstName)