Science Environment for Ecological Knowledge
Ecoinformatics site parent site of Partnership for Biodiversity Informatics site parent site of SEEK - Home
Science Environment for Ecological Knowledge









 

 

 



SMS Service Interfaces

Difference between version 67 and version 37:

Line 1 was replaced by lines 1-5
- !! Overview
+ !!! Intended audience
+ This document is intended for __SEEK and Kepler developers__.
+
+ It is a __DRAFT DESIGN DOCUMENT__ and does not reflect functionality as it
+ currently exists in Kepler or SEEK. Comments and feedback are appreciated.
Line 3 was replaced by line 7
- The following operations are described in more detail below.
+ !!! Overview
At line 4 added 2 lines.
+ The following lists the semantic-mediation service interfaces:
+
Line 8 was replaced by lines 14-24
- search( ConceptExpression, Set<ResourceType>, RemoteSearchFlag ) :: Set<ResourceID>
+ Set<ResourceID> search( ConceptExpression, Set<ResourceType>, RemoteFlag )
+
+ Set<QueryResult> query( QueryExpression, RemoteFlag )
+
+ Boolean match( ResourceID, ConceptExpression, RemoteFlag )
+
+ Boolean compatible( ResourceID, Connection, ResourceID, StructTypeFlag, RemoteFlag )
+
+ Set<ResourceID> searchCompatible( ResourceID, Port, StructTypeFlag, RemoteFlag )
+
+ Set<StructMapping> compose( ResourceID, Connection, ResourceID, RemoteFlag )
Line 10 was replaced by line 26
- query( QueryExpression, RemoteSearchFlag ) :: Set<QueryResult>
+ Set<StructMapping> merge( ResourceID, Connection, ResourceID, RemoteFlag )
At line 11 added 2 lines.
+ ConceptExpression semanticTypeConcepts( ResourceID, String, RemoteFlag ) // for summarizing annotations
+
At line 14 added 2 lines.
+ The rest of this page describes each of these services and their dependencies.
+
Line 16 was replaced by line 36
- !! {{Search}}: Simple Concept-Based Searching
+ !!! {{Search}}: Simple Concept-Based Searching
Line 18 was replaced by line 38
- {{{search( ConceptExpression, Set<ResourceType>, RemoteSearchFlag ) :: Set<ResourceID>}}}
+ {{{Set<ResourceID> search( ConceptExpression, Set<ResourceType>, RemoteFlag )}}}
Removed line 24
- The service returns a set of resources (as LSIDs) that have semantic annotations "matching" the given search term.
Line 26 was replaced by line 45
- We assume that (via a GUI) an initial search string has been converted to a description-logic concept expression. A concept expression can be single concept (like "Biomass") or a complex formula (including nested disjunctive and conjunctive formulas, and so on).
+ The service returns a set of resources (as LSIDs) that have semantic types "matching" the given search term.
At line 27 added 2 lines.
+ We assume that (via a GUI) an initial search string has been converted to a description-logic concept expression. A concept expression can be single concept (like "Biomass") or a complex formula (including nested disjunctive and conjunctive formulas, and so on). We assume each concept is associated to the ontology it is defined in (e.g., where the ontology is implied by the concept identifier).
+
Line 30 was replaced by line 51
- getResourceType( ResourceID ) :: ResourceType
+ ResourceType getResourceType( ResourceID )
Line 32 was replaced by line 53
- getSemanticAnnotations( RemoteSearchFlag ) :: Set<SemanticAnnotationID>
+ Set<SemanticTypeID> getSemanticAnnotations( RemoteSearchFlag )
Line 34 was replaced by line 55
- getOntology( OntologyID ) :: Set<Ontology>
+ Set<Ontology> getOntology( OntologyID )
Line 37 was replaced by line 58
- The first operation returns the resource type of a given resource identifier (an LSID). The second operation returns the set of semantic annotations known to the kepler object manager (including annotations stored on remote repositories depending on the value of the search flag). The last operation returns the ontology for a given ontology identifier (also a resource id).
+ The first operation returns the resource type of a given resource identifier (an LSID). The second operation returns the set of semantic types known to the kepler object manager (including semantic types stored on remote repositories depending on the value of the remote flag). The last operation returns the ontology for a given ontology identifier (also a resource id). Note that this last operation could be used with an ontology service, e.g., the simple one described at the end of this page[simple ontology service|1].
Line 39 was replaced by line 60
- ! Optimized searching
+ !! Optimized Remote Searching
Line 41 was replaced by line 62
- In general, the {{search}} operation requires access to all semantic annotations to find matching resources. For example, consider a search expression {{A and B}}, i.e., a resource must contribute to both concept {{A}} and concept {{B}}. To find appropriate matches for this search term, the algorithm must look for annotations that explicitly state {{A and B}} as well as those that state only {{A}} and only {{B}} (which taken together make {{A and B}}). Note that an annotation that states only {{A}} may be in one repository, while an annotation that states {{B}} may be in another. Thus, for remote searches, the {{search}} algorithm must gather and consider all remote annotations to find matching resources. The {{search}} operation is inherently centralized because of this situation.
+ In general, the {{search}} operation requires access to all semantic types to find matching resources. For example, consider a search expression {{A and B}}, i.e., a resource must contribute to both concept {{A}} and concept {{B}}. To find appropriate matches for this search term, the algorithm must look for semantic types that explicitly state {{A and B}} as well as those that state only {{A}} and only {{B}} (which taken together make {{A and B}}). Note that a semantic type that states only {{A}} may be in one repository, while a semantic type that states only {{B}} may be in another. Thus, for remote searches, the {{search}} algorithm must obtain and consider all remote semantic types to find matching resources, making the {{search}} operation inherently centralized.
At line 43 added 61 lines.
+
+ {{{
+ Set<RepositoryID> getRepositories()
+
+ Set<ResourceID> getResources( RepositoryID, Set<ResourceType> )
+
+ Set<ConceptExpression> partialSearch( RepositoryID, ConceptExpression, ResourceID )
+ }}}
+
+ Using these operations, the {{search}} algorithm would procede as follows, assuming that the remote flag has been selected. With the {{getRepositories}} service, the algorithm first obtains the available repositories from the local kepler object manager. The algorithm selects the first returned repository and with the {{getRepositories}} service, obtains the relevant resources in the respository. For each resource in the repository, the {{partialSearch}} service is used, which returns the parts of the concept expression that the resource matches (e.g., just the concept {{A}}). The algorithm then moves to the next repository, performing the same steps. However, for those resources already having partial matches (from the previous step), the algorithm reformulates the search term given to {{partialSearch}} to include only the additional required parts of the concept expression (e.g., just the concept {{B}}). Once a complete match is found, the resource is considered a match and is not further checked. Finally, the algorithm repeats the process until all repositories have been examined.
+
+
+ !!! {{Query}}: Complex Concept-Based Searching
+
+ {{{
+ Set<QueryResult> query( QueryExpression, RemoteFlag )
+ }}}
+
+
+
+
+ !!!{{Match}}: Checking Matching Resources
+
+ {{{
+ Boolean match( ConceptExpression, ResourceID, RemoteFlag )
+ }}}
+
+
+ The arguments for this service are:
+ # A resource whose semantic types are to be checked;
+ # A concept expression; and
+ # A flag denoting whether local or remote repositories are searched
+
+ The service returns true if the resource has a semantic type matching the concept expression. Note that given a set of resources {{R}} returned by the {{search}} service for a concept expression {{c}} and remote flag value {{m}} (either true or false), for each {{r}} in {{R}}, {{match(r, c, m)}} is true. That is, {{r}} is a {{match}} for search {{c}}.
+
+ The {{match}} service is included primarily to support browsing of ontologies.
+
+
+ !!! {{Compatible}}: Checking Semantically Well-Formed Connections
+
+ {{{
+ Boolean compatible( ResourceID, Connection, ResourceID, StructTypeFlag, RemoteFlag )
+ }}}
+
+
+
+ !!! {{SearchCompatible}}: Searching for Semantically Well-Formed Connections
+
+ {{{
+ Set<ResourceID> searchCompatible( ResourceID, Port, StructTypeFlag, RemoteFlag )
+ }}}
+
+
+ !!! {{Compose}}: Suggesting Well-Structured Actor Connections
+
+ {{{
+ Set<StructMapping> compose( ResourceID, Connection, ResourceID, RemoteFlag )
+ }}}
+
+ !!! {{Merge}}: Suggesting Simple Merging of Heterogeneous Datasets
+
Line 45 was replaced by lines 127-128
- getRepositories() :: Set<RepositoryID>
+ Set<StructMapping> merge( ResourceID, Connection, ResourceID, RemoteFlag )
+ }}}
Removed line 47
- getResources( RepositoryID ) :: Set<ResourceID>
Line 49 was replaced by lines 131-134
- partialSearch( RepositoryID, ConceptExpression, ResourceID ) :: Set<ConceptExpression>
+ !!! {{SemanticType}}: Summarizing Semantic Annotations
+
+ {{{
+ ConceptExpression semanticType( ResourceID, String, RemoteFlag )
Line 51 was replaced by lines 136-149
- Using these operations, the search algorithm would procede as follows. First, the search algorithm contacts a remote repository ...
+
+
+ !!! A Simple Ontology Interface
+
+ [simple ontology interface|#1]
+
+ {{{
+ interface ISimpleOntologyAccess {
+
+ Set<ConceptID> getConcepts( OntologyID )
+
+ Set<RoleID> getRoles( OntologyID ) :: Set<RoleID>
+
+ Set<ConceptID> getMatchingConcepts( OntologyID, String )
Line 53 was replaced by lines 151-153
- This needs some work: what we want to do is, e.g., ask S1 it's resources (e.g., R1, R2, and R3) and then "ship" the expressions (C1 and C2)/R1, (C1 and C2)/R2, and (C1 and C2)/R3 only to S1, which would return R1/match, R2/C1, R3/C2, and then we would want to do something similar with S2: ask it what resources it has, then ship (C1 and C2)/RX to S2 except if X=2 or X=3, in which case we would ship (R2/C2) and (R3/C1), and so on
+ Set<ConceptID> getMatchingRoles( OntologyID, String )
+
+ Set<ConceptID> getSubConcepts( OntologyID, ConceptID, DirectFlag )
At line 54 added 10 lines.
+ Set<ConceptID> getSuperConcepts( OntologyID, ConceptID, DirectFlag )
+
+ Set<RoleID> getSubRoles( OntologyID, RoleID, DirectFlag )
+
+ Set<RoleID> getSuperRoles( OntologyID, RoleID, DirectFlag )
+
+ Booolean satisfies( ConceptExpression, ConceptExpression )
+
+ }
+ }}}
Line 56 was replaced by line 166
- Here a semantic type is a concept expression generated from a semantic annotation. Providing and index over a resource's
+ !!! Comments

Back to SMS Service Interfaces, or to the Page History.