Analysis Data Transfer Framework "ORIENT" Specification

Transcription

1 NPW3C Analysis Data Transfer Framework "ORIENT" Specification Revision 1.9 Last update: February 7, 2011 NEC Corporation NEC Corporation 2010

2 Table of contents 1 Introduction Objective Terminologies and Namespaces Correspondence between ARMOR and ORIENT The ARMOR Interfaces which use ORIENT ARMOR Use Cases which Use ORIENT ORIENT: Operation / Restriction / Entities Based Framework Concept Notations in Model Schema Diagram Hierarchy of ORIENT ORIENT Resource Framework Overview ABF (ARMOR Base Framework) AOF (ARMOR Operation Framework) ARF (ARMOR Restriction Framework) Domain Specific Model (DSM) Overview Name Space URI ModelSchema Reference Model Example of DSM Protocol Message Transmission ORIENT RDF/XML Serialization Rule Restriction Descriptions and Examples Restriction Descriptions (Method to express Restriction) Restriction Examples Operation Descriptions and Examples Query Operation Write Operation Notify Operation...72 Appendix A Operation Descriptions and Examples (Detailed Version) A.1 Query Operation...81 A.2 Write Operation...85 A.3 Notify Operation...87 NEC Corporation /91

3 Figures Figure 1 Component Diagram and Interfaces of ARMOR... 8 Figure 2 ARMOR Use Case Diagram... 9 Figure 3 Basic Resource Structure of ORIENT...10 Figure 4 Relations between Model Schema, Reference Model and Instance...11 Figure 5 Example of Datatype Notation...12 Figure 6 Example of Datatype with rdf:bag or rdf:seq notation...12 Figure 7 Example of object property notation...13 Figure 8 Example of Object with rdf:bag or rdf:seq notation...13 Figure 9 Example of external URI reference notation...14 Figure 10 Example of external URI reference notation...14 Figure 11 Example of Type URI reference notation...15 Figure 12 Example of Inheritance notation...15 Figure 13 ORIENT Framework Hierarchy...16 Figure 14 ORIENT Framework Model Schema...17 Figure 15 ARF Model Schema Diagram (detailed)...25 Figure 16 Reference Model Diagram Example...41 Figure 17 Model Schema Diagram of Person information DSM...43 Figure 18 Reference Model Diagram of Person Information DSM...43 Figure 19 Query Restriction Description...48 Figure 20 Scope Description...48 Figure 21 Condition Description...49 Figure 22 RDF Model Example for Person Search...51 Figure 23 Sequence Diagram of Query Operation...53 Figure 24 Sequence Diagram of Write Operation...67 Figure 25 Sequence Diagram of Notify Operation (when issued by ARMOR)...72 Figure 26 Sequence Diagram of Notify Operation (when issued by Engine)...73 Figure 27 Sequence Diagram of Query Operation...81 Figure 28 Sequence Diagram of Write Operation...85 Figure 29 Sequence Diagram of Notify Operation...87 NEC Corporation /91

4 Tables Table 1 Terminologies... 5 Table 2 Namespaces... 6 Table 3 Correspondence between ARMOR Interfaces and ORIENT Operations... 7 Table 4 Correspondence between ARMOR Use Cases and ORIENT Operations... 9 Table 5 Object Properties Defined in ABF...18 Table 6 Datatype Properties Defined in ABF...18 Table 7 Object Properties Defined in AOF...22 Table 8 Datatype Properties Defined in AOF...22 Table 9 Object Properties Defined in ARF...25 Table 10 Datatype Properties Defined in ARF...26 Table 11 Namespaces Used in Person DSM...42 Table 12 Class Definition of Person Information DSM...42 Table 13 Object Definition of Person Information DSM...42 Table 14 Data Type Definition of Person Information DSM...42 Table 15 Reference Node URI List of Person Information DSM...44 Table 16 HTTP Header Configuration Value While Transmitting ORIENT Message...46 Table 17 HTTP Status Code and Message Body When HTTP POST Received...46 Table 18 Type and operation overview of arf:filter that can be used in scope expression...49 Table 19 Types and operation overview of arf:filter used in expressing Condition...50 Table 20 Actors in Query Operation...53 Table 21 ORIENT Resource Status in Query Operation...54 Table 22 Actors in Write Operation...67 Table 23 ORIENT Resource Status in Write Operation...67 Table 24 Actors in Notify Operation...72 Table 25 ORIENT Resource Status in Notify Operation...73 Table 26 ORIENT Resource Status in Query Operation...81 Table 27 ORIENT Resource Status in Write Operation...85 Table 28 ORIENT Resource Status in Notify Operation...87 NEC Corporation /91

5 1 Introduction 1.1 Objective This document describes the basic design of Operation / Restriction / Entities based framework (ORIENT). ORIENT provides data exchange framework for analysis data manager. The objective of ORIENT is to define the IF between internal modules of analysis data manager and the IF, which exists between analysis data manager, user application and analysis engine, and to realize their interoperability. ORIENT defines the following items. Specifications of RDF graph exchanged by internal IF of analysis data manager Transmission protocol specifications of external IF of analysis data manager Definition method of domain-wise logical data structure (DSM) to express analysis results 1.2 Terminologies and Namespaces Terminologies In this document, analysis data manager is mentioned as Analysis Result Manager for Online Retrieval (ARMOR) and analysis providing server is mentioned as User application. The terminologies used in this document are shown in Table 1. Table 1 Terminologies Term ARMOR Definition Notation for analysis data manager used in this document.armor stands for Analysis Result Manager for Online Retrieval. ORIENT ORIENT is a data transfer framework for ARMOR. ORIENT stands for Operation / Restriction / Entities based data transfer framework. ORIENT consists of ABF, AOFs, DSM, and ORIENT Ontology. ABF AOF ARF DSM Class RDF Type Data Object Operation ABF specifies base components of ORIENT. ABF stands for ARMOR Base Framework. AOF is a framework of ORIENT for operations. AOF stands for ARMOR Operation Framework. ARF is a framework of ORIENT for restrictions. ARF stands for ARMOR Restriction Framework. DSM is a model for domain specific metadata such as data types. DSM stands for Domain Specific Model. Type of RDF resource in ORIENT message Same as Class. which takes value (rdfs:literal) in range. The definition is same as that of Datatype of OWL. which takes resource (rdfs:resource) in range. The definition is same as that of Object of OWL. Operations (Query, Write and Notify) for analysis data defined by ORIENT Message Data in ORIENT format, which is exchanged between every module in the execution flow of operations Namespaces The namespaces used in this document are shown in Table 2. NEC Corporation /91

6 Table 2 Namespaces Abbreviations URL Description xsd XML Schema Rdf RDF rdfs RDF Schema Dc Dublin core Abf ARMOR base framework Aof ARMOR operation framework Arf ARMOR restriction framework NEC Corporation /91

7 2 Correspondence between ARMOR and ORIENT 2.1 The ARMOR Interfaces which use ORIENT ORIENT defines the data framework for following interfaces interior and exterior of ARMOR: ARMOR exterior interfaces ARMOR online request interface ARMOR online engine execution interface ARMOR analysis result write interface Notification receive interface ARMOR interior interfaces Online request interface Online engine execution interface Analysis result write interface Table 3 shows the correspondence between ARMOR interfaces and ORIENT operations. Table 3 Correspondence between ARMOR Interfaces and ORIENT Operations Exterior/interior ARMOR interface ORIENT operation Exterior ARMOR online request interface Query Exterior ARMOR online engine execution interface Query, Notify Exterior ARMOR analysis result write interface Write Exterior Notification receive interface Notify Interior Online request interface Query Interior Online engine execution interface Query, Notify Interior Analysis result write interface Write NEC Corporation /91

8 Figure 1 Component Diagram and Interfaces of ARMOR NEC Corporation /91

9 2.2 ARMOR Use Cases which Use ORIENT Table 4 shows the correspondence between ARMOR use cases, actors and ORIENT operations. Table 4 Correspondence between ARMOR Use Cases and ORIENT Operations Use Case Issued by ORIENT operation Analysis result request (Query) Analysis providing server (User application) Engine (analysis engine) Query Notification request (Notify) Engine (analysis engine) Notify Analysis result record (Write) Engine (analysis engine) Write Figure 2 ARMOR Use Case Diagram NEC Corporation /91

10 3 ORIENT: Operation / Restriction / Entities Based Framework 3.1 Concept Basic Resource Structure ORIENT defines RDF graph structure and controlled vocabularies for ARMOR interfaces. As shown in Figure 3, the framework distinguishes three categories of data: (1) Operation specific data (Operation) (2) Restriction specific data (Restriction) (3) Analysis result specific data (Entities) Operation specific data such as: Type of operation (Query, Write, etc.) List of engines required for the operation Restriction on Entities such as: Conditions to filter entities Scope of resulting Entities Condition Scope DS Restriction Operation ORIENT Entities such as: Write data Query results Analysis results Entities Entity Entity DS Figure 3 Basic Resource Structure of ORIENT Operation describes the request for the platform. Restriction describes the restriction on the operation and/or Entities such as filtering condition on Entities, notify destination URL. Entities describe objective data of the operation such as document information. Each process of an ARMOR operation handles the unique instance of data model described with Operation, Restriction and Entities. The engines and processes of ARMOR operation share unique instance in each operation and append and/or update resources or literals to the shared model. NEC Corporation /91

11 3.1.2 Model Schema, Reference Model and Instances Lexical structure (Model Schema) to express analysis data and the Model (Reference Model) to refer to model elements described based on the Model Schema, are defined in ORIENT framework and DSM. As regards Application, Engine and ARMOR, actual analysis data is described as instance using this Model Schema and Reference Model. Defined in ORIENT and DS Model Schema (UML Diagram) Class_A data_a object_a Class_C object_b Class_B data C data B Defined in DS Reference Model (Directed Edge Graph) object_a URI Class_C object_b URI Class_A data_c Class_B data_a URI rdfs:literal data_b URI rdfs:literal URI URI rdfs:literal object_a instance of rdf:type Class_A Resource data_a Literal Refers to (as Filter target identifier in ARF) rdf:type Class_C Resource Literal object_b data_c rdf:type Class_B Resource Literal data_b Instance (RDF) Generated by Engine/Application/ARMOR Figure 4 Relations between Model Schema, Reference Model and Instance 3.2 Notations in Model Schema Diagram The Notations in Model Schema and the mappings between the Model Schema notations and the instances generated by Engine, ARMOR and Application, which are based on these notations, are shown Datatype Datatype Datatype is a property which holds rdfs:literal as the domain in RDF. Datatype is mentioned as an attribute of class in UML class diagram. Cardinality is mentioned after the attribute name and can be abbreviated if Cardinality is 1. Notation is as follows. Notation: Name [CARDINALITY]: XSDDatatype Example: dc:date 1..* : XSDDatatype In the example shown below, the instance of abf:operation class has Datatype known as dc:date and the value is xsd:datetime type. Further, a concrete example of an instance based on this NEC Corporation /91

12 schema expression is shown in the below given figure. Example of Model Schema Expression Instance RDF/XML example <abf:operation rdf:about=" <dc:date rdf:datatype=" </abf:operation> Figure 5 Example of Datatype Notation Datatype with rdf:bag or rdf:seq As regards Datatype with rdf:bag or rdf:seq, the literal value set of range is compiled in rdf:bag or rdf: Seq within Datatype. Datatype with rdf:bag or rdf:seq is an attribute of a class and mentioned as an attribute with rdf:bag or rdf:seq as a stereotype. In the example shown below, the instance of Example class is example property and has data property with rdf:bag or rdf:seq, and the value, which is xsd:datetime type, is bundled in rdf:bag. It also shows a concrete example of an instance based on this schema expression. Example of Model Schema Expression Instance RDF/XML example <Example rdf:about= <example> <rdf:bag> <rdf:li rdf:datatype=" <rdf:li rdf:datatype=" </rdf:seq> </example> </Example> Figure 6 Example of Datatype with rdf:bag or rdf:seq notation Object (URI Reference) Object is a property with range as URI (resource). URI is specified in rdf:resource property of RDF. Object Object property is a property which has rdfs:resource as a domain in RDF. Object property is shown as a relation between classes. Cardinality is based on notation of UML. In the example shown below, the instance of abf:operation class has an object property known as aof:processflow and the value is an instance of aof:processflow type. It also shows a concrete example of an instance based on this schema expression. NEC Corporation /91

13 Example of Model Schema Expression Instance RDF/XML example <abf:operation rdf:about=" <aof:procesflow rdf:resource= /> </abf:operation> <aof:processflow rdf:about= > </aof:processflow> Figure 7 Example of object property notation Object with rdf:bag or rdf:seq As regards Object property with rdf:bag or rdf:seq, instance group of range is complied in rdf:bag or rdf:seq within object property. Object property with rdf:bag or rdf:seq is mentioned as a relation between classes, which has rdf:bag or rdf:seq as stereotype. In the example shown below, the instance of aof:processflow class is aof:operationsequence and has object property with rdf:bag or rdf:seq; and instance group of aof:processphase type, which is the value, is bundled in rdf:seq. It also shows a concrete example of an instance based on this schema expression. Example of Model Schema Expression Instance RDF/XML example <aof:processflow rdf:about= <aof:operationsequence> <rdf:seq> <rdf:li rdf:resource= example.ex.xx/instance/processphase001 /> <rdf:li rdf:resource= example.ex.xx/instance/processphase002 /> </rdf:seq> </aof:operationsequence> </aof:processflow> <aof:processphase rdf:resource= example.ex.xx/instance/processphase001 /> <aof:processphase rdf:resource= example.ex.xx/instance/processphase002 /> Figure 8 Example of Object with rdf:bag or rdf:seq notation Object (Reference Only) Object property (Reference Only) is a property wherein the instance of range does not need to appear in same graph (ORIENT message) within object property. This property is used at the time of referring to vocabulary in Terminology defined in separate DSM, etc. by specifying URI. Further, Reference Only can also be specified in the same way in object property with rdf:bag or rdf:seq. Object property (Reference Only) is mentioned as a relation between classes, which has Reference Only as a restriction. In the example shown below, the instance of aof:engineoperation class has reference only object property known as aof:engineuri and value is URL of Engine API. A concrete example of an Instance NEC Corporation /91

14 based on this schema expression is shown below. As given in this example, resource of Engine URL (reference destination) need not exist in RDF/XML of instance in case of Reference Only. Example of Model Schema Expression Instance RDF/XML example <aof:engineoperation rdf:about=" <aof:engineuri rdf:resource=" </aof:engineoperation> Figure 9 Example of external URI reference notation Here, is an example of URL of Engine API. Object (Referable) Object property (Referable) is a property wherein instance of range may or may not appear in same graph (ORIENT message) within object property. In other words, the resource existence of range of this property varies with each message. Further, Referable can also be specified in the same way in object property with rdf:bag or rdf:seq. Object property (Referable) is mentioned as a relation between classes, which has Referable as a restriction. The below mentioned example shows that the instance of abf:operation class has object property of referable known as aof:processflow and resource of aof:processflow instance or its URI as the value. A concrete example of an instance based on this schema expression is shown. As shown in this example, the resource of Engine URL (reference destination) need not exist in RDF/XML of instance in case of Referable. Example of Model Schema Expression Instance RDF/XML example (when resource exists in same message) <abf:operation rdf:about=" <aof:procesflow rdf:resource= /> </abf:operation> <aof:processflow rdf:about= > </aof:processflow> Instance RDF/XML example (when resource does not exist in same message) <abf:operation rdf:about=" <aof:procesflow rdf:resource= /> </abf:operation> Figure 10 Example of external URI reference notation Here, is an example of URL of Engine API. NEC Corporation /91

15 Type URI reference Type URI reference is a URI reference, which specifies URI indicating class (Type). In Type URI reference, definition of class corresponding to URI of range does not appear in the graph. Type URI reference is mentioned as a relation between classes, which has Type URI reference as a restriction. The below mentioned example shows that the instance of arf:scope class has type URI reference known as arf:entitytype and the value is URI ( of ds:person class defined in DSM(ds/general). A concrete example of an instance based on this schema expression is shown. Example of Model Schema Expression Instance RDF/XML example <arf:scope rdf:about=" "> <arf:entitytype rdf:resource=" </arf:scope> Figure 11 Example of Type URI reference notation Inheritance Inheritance shows the inheritance relationship between classes (type). Subclass inherits the properties of higher-level class. As a general rule, all the higher level classes are required to be mentioned in rdf:type at the time of defining instance in ORIENT message. Inheritance is mentioned in inheritance relationship between classes. Further, it is mentioned as Abstract class in case Optional subclass is expressed. The below mentioned example shows that aof:query class is the subclass of abf:operation class. It also includes a concrete example of an instance based on this schema expression. Example of Model Schema Expression Instance RDF/XML example <abf:operation rdf:about=" "> <rdf:type rdf:resource=" </abf:operation> Figure 12 Example of Inheritance notation NEC Corporation /91

16 3.3 Hierarchy of ORIENT ORIENT framework has hierarchal structure as shown in Figure 13. Based on common RDF/XML layer, ORIENT framework uses following frameworks and data vocabularies. Framework: ABF: defines the common classes, properties, and their structure for internal/external ARMOR data transfer. AOF: defines operation specific RDF structure, classes and properties. Each operation type (Query, Data writing and Notification) has different operation framework. ARF: defines information structure to express the logics of restriction condition. Data vocabularies: DSM: defines domain specific resources, properties. Each domain (Still image processing, Text processing, etc) has different model. The data for specific application is expressed on ABF, AOF, ARF and one or more DSM. Domain Specific Model Application Application Engine ASM DS_ST DS_TIME DS_SPACE DS_DOC DS Engine ORIENT framework AOF ABF ARF RDF/XML RDF XML ABF: ARMOR base framework, AOF: ARMOR operation framework, ARF: ARMOR restriction Framework, DS: Domain specific model, DS_ST: DS for Spatiotemporal domain, DS: General DS Figure 13 ORIENT Framework Hierarchy NEC Corporation /91

17 4 ORIENT Resource Framework 4.1 Overview Figure 14 ORIENT Framework Model Schema The ORIENT resource model is constructed with following 3 frameworks: ABF (ARMOR Base Framework) ABF is the base framework of ORIENT. ABF defines Operation, Restriction, Entities and Entity. AOF (ARMOR Operation Framework) AOF describes the information corresponding to each operation. AOF defines the type of operation, EngineOperation, ProcessFlow, status of each operation. ARF (ARMOR Restriction Framework) ARF describes the information corresponding to the restriction on the Entities. ARF defines condition (Equals, Contains, Exists, Ranges) and logics (Or, OrderedBy) of each operation. NEC Corporation /91

18 4.2 ABF (ARMOR Base Framework) Overview of ABF ABF is the base framework of ORIENT. ABF defines Operation, Restriction, Entities and Entity Properties Defined in ABF Table 5 and Table 6 show the properties defined in ABF. Table 5 Object Properties Defined in ABF Properties Super Domain Range Definition abf:hasrestriction - abf:operation abf:restriction Indicates the Restriction the Operation uses. abf:restrictedby - abf:entities abf:restriction Indicates that the Entities were derived from filtering entities by Restriction abf:operatedby - abf:entities abf:operation Indicates the Operation by which the Entities are operated. abf:hasscope - abf:entities arf:scope Indicates that the Entities were derived for the specified Scope. abf:entities - abf:entities rdf:seq of abfentity Indicates Entities rdf:bag of abfentity abf:import - abf:vocabulary rdfs:resource (Name Space URI of DSM) Indicates DSM used by this message Table 6 Datatype Properties Defined in ABF Properties Super Domain Range Definition abf:all - abf:entities rdfs:literal (xsd:integer) abf:count - abf:entities rdfs:literal (xsd:integer) abf:offset - abf:entities rdfs:literal (xsd:integer) Total number of Entities corresponding to arf:condition (search conditions) and arf:entity Type attribute (specify Type of returned Entity) of arf:scope. Count of Entities corresponding to both arf:condition and arf:scope. It matches with the number of Entities, which are actually saved in abf:entities as a result. Index of the Entities, which are actually saved as result in abf:entities, from the list of Entities corresponding to abf:restriction. NEC Corporation /91

19 4.2.3 Resource Types (Classes) Defined in ABF In this section, definition, properties, meanings, Cardinality and range of each class are explained for Resource Type (Class) defined in ABF. abf:operation Definition Class for a RDF resource describes information about Operation. All information about operation should be stored / linked to this resource. Resource URI Meaning: It is an ID for distinguishing ARMOR, Engine and Application in this operation Uniqueness: Globally unique list dc:date abf:hasrestriction abf:processflow Type Datatype Object Object (Referable) Range rdfs:literal (xsd:datetime) Cardinality Write Query Notify Description 1:1 1:1 1:1 Date and time of executing operation abf:restriction 1:1 1:1 1:1 Conditions of operation (Filter conditions or information of notification destination) aof:processflow 1:0..1 1:0..1 1:0..1 Procedure to run analysis engine to realize this operation. Resource of reference destination need not exist (It exists in case of Reference Only) abf:restriction Definition Class for a RDF resource describes information about Restriction. All information about restriction of the Entities should be stored / linked to this resource. Resource URI Meaning: It is a URI for distinguishing abf:restriction resource in this operation. Uniqueness: message unique list arf:monitoredby arf:hascondition arf:hasscope Type Object (Reference Only) Object Object Range Cardinality Write Query Notify Description URL n/a n/a 1:* Indicates URL of notification destination in Notify operation. arf:condition n/a 1:1 n/a Indicates condition to narrow down Entity arf:scope n/a 1:* n/a Indicates the scope, which is desired as result, out of the information mapped to Entity. NEC Corporation /91

20 abf:entities Definition Class for a RDF container storing set/seq of Entity those describe the analysis results. All Entities those express the analysis results should be contained in this resource. Resource URI Meaning: It is a URI to identify abf:entities resource in this operation. Uniqueness: message unique list abf:all abf:count abf:offset abf:entities abf:operatedby abf:hasscope abf:restrictedby Type Datatype Datatype Datatype Object with rdf:bag or rdf:seq Object Object Object Range Cardinality Description rdfs:literal (xsd:integer) rdfs:literal (xsd:integer) rdfs:literal (xsd:integer) rdf:seq of abfentity rdf:bag of abfentity 1:0..1 Total number of Entities corresponding to arf:condition (search conditions) and arf:entity Type attribute (specify Type of returned Entity) arf:scope. 1:1 Count of Entities corresponding to arf:condition and arf:scope. It matches with the number of Entities, which are actually saved in abf:entities as result. 1:0..1 Index of the Entities, which are actually saved as result in abf:entities, from the list of Entities corresponding to abf:restriction. 1..*:0..* Combinations or set of abf:entity bundled by these Entities resources. abf:operation 0..1:1 Indicates abf:operation, which shows the Operation that targets this Entities resource. arf:scope 0..*:0..1 Indicates arf:scope, which corresponds to result included in these Entities. abf:restriction 0..*:1 Indicates abf:restriction resource, which restricts this Entities resource. abf:entity Definition Class for a RDF expresses the analysis result. Detailed analysis result information is stored as this resource. Resource URI Meaning: Used as identifier of the analysis result. Uniqueness: Globally unique list Properties are defined in DSM. abf: Vocabulary Definition Class for a RDF resource that describes which DSM is used in the operation. NEC Corporation /91

21 Resource URI Meaning: It is a URI to identify abf:vocabulary resource in this operation. Uniqueness: message unique list abf:import Type Object (Reference Only) Range Cardinality Description rdfs:resource 1:1..* Clearly specifies DM, which is used by this message. Name Space URI of DSM is taken as value. NEC Corporation /91

22 4.3 AOF (ARMOR Operation Framework) AOF describes the information corresponding to each operation. AOF defines the type of operation, EngineOperation, ProcessFlow, status of each operation Properties Defined in AOF Table 7 and Table 8 show the properties defined in AOF. Table 7 Object Properties Defined in AOF Properties Super Domain Range Definition aof:processflow - abf:operation aof:processflow Indicates the ProcessFlow of the Operation. aof:operationsequen ce - aof:processflow rdf:seq of aof:processphase Expresses the process flow by sequences of ProcessPhase aof:hasengineopera tion - aof:processphase rdf:bag of aof:engineoperation Expresses the engines which executed in parallel. aof:statusof - abf:status abf:operation Indicates the Operation or aof:engineoperation EngineOperation of which the Status stores the execution status. aof:engineuri - aof:engineoperation rdfs:resource The URI of processing engine. Table 8 Datatype Properties Defined in AOF Properties Super Domain Range Definition aof:code - aof:status rdfs:literal (xsd:positiveinteger) The status code of the Operation and EngineOperation. aof:message - aof:status rdfs:literal The status message of the (xsd:string) Operation and EngineOperation. aof:timeout - aof:engineoperation rdfs:literal (xsd:positiveinteger) The value of engine execution timeout (msec) aof:ratio - aof:engineoperation rdfs:literal (xsd:float) The weight of the properties of Entity returned from each engine. (min:-1, max:1) NEC Corporation /91

23 4.3.2 Resource Types (Classes) Defined in AOF In this section, definition, properties, meanings, Cardinality and Range of each class are explained for Resource Type (Class) defined in AOF. aof:query Definition Operation type is a class used for Query message. Resource URI Meaning: It is an ID for distinguishing ARMOR, Engine and Application in this operation Uniqueness: Globally unique list It inherits the properties of super class. aof:write Definition Operation type is a class used for Write message. Resource URI Meaning: It is an ID for distinguishing ARMOR, Engine and Application in this operation Uniqueness: Globally unique list It inherits properties of super class. aof:notify Definition Operation type is a class used for Notify message. Resource URI Meaning: It is an ID for distinguishing ARMOR, Engine and Application in this operation. Uniqueness: Globally unique list It inherits the properties of super class. aof:processflow Definition It is a class of ProcessFlow, which is the processing method of engine. The Engine processing method described in ORIENT supports sequential execution and parallel execution of engine. Process Phase list, which carries out sequential execution, is expressed in ProcessFlow class. Resource URI Meaning: It is an ID for distinguishing ARMOR, Engine and Application in this process flow Uniqueness: Globally unique list Range Cardinality Description aof:operationsequence aof:processphase 1:1..* List of process phases, which consists this process flow. These process phases are executed in the sequential order of list. aof:processphase Definition It is a class of ProcessPhase, which shows a series of engines that are executed in parallel in the processing method of engine. The Engine processing method described in ORIENT supports sequential NEC Corporation /91

24 execution or parallel execution of engine. A set of engines, which are executed in parallel, is shown in ProcessPhase class. Engine operation included in the process phase is carried out in parallel. Same ORIENT model is entered at the time of calling each engine. Resource URI Meaning: It is an ID for distinguishing ARMOR, Engine and Application in this process phase. Uniqueness: Globally unique list Range Cardinality Description aof:hasengineoperation aof:engineoperation 1:1..* List of engines, which consist this process phase. The engine operations included in this process phase are executed in parallel. Same ORIENT model is entered at the time of calling each engine. aof:engineoperation Definition It is the class for expressing information required for Engine execution. Resource URI Meaning: It is an ID for distinguishing ARMOR, Engine and Application in this engine operation Uniqueness: Globally unique list Range Cardinality Description aof:engineurl URL 1:1 URL for calling API of analysis engine. ORIENT message is posted in this URL. aof:timeout aof:ratio rdfs:literal (xsd:integer) rdfs:literal (xsd:float) 1:1 Timeout value of HTTP Post for engine. Unit is msec. 1:0..1 (For future) Evaluation value for efficiency and accuracy of this engine. Usage in Entity selection and result integration is assumed, in case same types of engines are executed in parallel. aof:status Definition It is a class to show execution status of engine and entire operation. It can be confirmed from reference destination of aof:statusof property whether aof:status is the status for entire operation or it is just for a specific Engine Operation. Resource URI Meaning: It is an ID to identify Status instance in message Uniqueness: Message unique list Range Cardinality Description aof:statusof aof:code aof:engineoperation abf:operation rdfs:literal (xsd:positiveinteger) 1:1 Indicates this Status resource is related to which Operation/EngineOperation. 1:1 Status code of processing. It conforms to status code of HTTP (RFC2616). aof:message rdfs:literal 1:1 Natural language message related to NEC Corporation /91

25 (xsd:string) processing status. 4.4 ARF (ARMOR Restriction Framework) ARF describes the information corresponding to the restriction and condition of the Entities. ARF defines condition and logics (AND, OR) of each operation. Figure 15 shows model schema diagram for ARM in detail. Figure 15 ARF Model Schema Diagram (detailed) Properties Defined in ARF Table 9 and Table 10 show the properties defined in ARF. Table 9 Object Properties Defined in ARF Properties Super Domain Values Definition arf:monitoredby - arf:restriction URI of monitoring Indicates the URI of User application, User application which receives notification from ARMOR. arf:hascondition - abf:restriction arf:condition Indicates the Condition resource which expresses the restriction condition of the Entities. NEC Corporation /91

26 Properties Super Domain Values Definition arf:hasscope - abf:restriction arf:scope Indicates the Scope resource which expresses the required result Entity skeleton (scope of properties and resources of the Entity). arf:entitytype - arf:scope rdfs:class Indicates the entity type of result Entity. arf:scope - arf:scope rdf:bag of Reference Model Node URI Indicates the property values and resources which appear in result Entity if they are existed. arf:valueresource - arf:filter rdfs:resource Indicates the filter value for arf:evaluates resource. arf:beginresource arf:valuere source arf:filter rdfs:resource Indicates the begin value for the ranged filter values. arf:endresource arf:valuere source arf:filter rdfs:resource Indicates the end value for the ranged filter values. arf:evaluates - arf:filter URI of Reference Indicates the filter target resource. Model Node URI arf:hasexpression - arf:matches arf:expression Specifies Expression, which is target of evaluation. arf:hasfilter - arf:scope arf:condition arf:logic arf:filter Indicates the filter for the Scope, Condition, or Filter. Table 10 Datatype Properties Defined in ARF Properties Super Domain Values Definition arf:value - arf:filter rdfs:literal Indicates the filter value for arf:evaluates resource. arf:begin arf:value arf:filter rdfs:literal Indicates the begin value for the ranged filter values. arf:end arf:value arf:filter rdfs:literal Indicates the end value for the ranged filter values. arf:includebegin - arf:filter rdfs:literal Scope conditions of arf:begin or (xsd:boolean) arf:beginresource. In case of true, include in scope. It certainly occurs for both arf:begin and arf:beginresource. arf:includeend - arf:filter rdfs:literal Scope conditions of arf:end or (xsd:boolean) arf:endresource. In case of True, include in scope. It certainly occurs for both arf:end or arf:endresource. arf:from - arf:orderedby rdfs:literal (xsd:integer) Begin index of returned Entity range in sequence of ordered result entities. arf:to - arf:orderedby rdfs:literal (xsd:integer) End index of returned Entity range in sequence of ordered result entities. NEC Corporation /91

27 4.4.2 Resource Types (Classes) Defined in ARF In this section, definition, properties, meanings, Cardinality and Range are explained for Resource Type (Class) defined in ARF. arf:condition Definition It is a class of resource to describe conditions for Entity, which is required as a result. Resource URI Meaning: It is a URI for distinguishing identify arf:condition resource in this operation. Uniqueness: message unique list Range Cardinality Description arf:hasfilter arf:filter 1:0..1 Filtering conditions for selecting Entity. arf:scope Definition It is a class of resource to define type of Entity, which is desired as a result, and information scope (sub graph, resource and property under Entity.) specification within that Entity. Resource URI Meaning: It is a URI for distinguishing arf:condition resource in this operation. Uniqueness: message unique list Range Cardinality Description arf:entitytype Subclass of arf:entity (defined in DSM) 1..*:1 Indicates RDF type (class) of Entity, desired to obtain in this Scope in the end. arf:hasfilter arf:filter 1..*:0..1 Indicates the filter, which restricts information scope of Entity, which are desired as a result, and the filter, which gives the sequence of Entities corresponding to this Scope. arf:scope rdf:bag of Reference Model Node URI 1:1..* Indicates information (resource or literal) of Entity, which is desired as a result. All the Reference Model Node URIs from the Entity indicated in arf:entitytype to target node, are mentioned. arf:filter Definition It is a super class of class group that shows conditions. Resource URI Meaning: It is a URI for distinguishing arf:filter resource in this operation. Uniqueness: message unique list They are defined in subclass. arf:logic Definition NEC Corporation /91

28 Super Class: arf:filter It is a super class of filter class group, which shows logical operations. The items of logical operation are expressed as multiple filters, which are available in arf:hasfilter property. Resource URI Meaning: It is a URI for distinguishing arf:logic resources in this operation. Uniqueness: message unique list Range Cardinality Description arf:hasfilter arf:filter 0..*:1..* Indicates filter corresponding to each section of logical operation. arf:and Definition Super Class: arf:logic It is a filter class, which indicates AND logical operation. Entity is filtered to fulfill all filter group, possessed by arf:hasfilter. Resource URI Meaning: It is a URI for distinguishing arf:and resources in this operation. Uniqueness: message unique list of super class is inherited. arf:or Definition Super Class: arf:logic It is a filter class, which indicates OR logical operation. Entity is filtered to fulfill any filter group, possessed by arf:hasfilter. Resource URI Meaning: It is a URI for distinguishing arf:or resources in this operation. Uniqueness: message unique list of super class is inherited. arf:not Definition Super Class: arf:logic It is a filter class, which indicates NOT logical operation. Entity is filtered not to fulfill the filters, possessed by arf:hasfilter. Resource URI Meaning: It is a URI for distinguishing arf:not resources in this operation. Uniqueness: message unique list Range Cardinality Description arf:hasfilter <Override> arf:filter 1:1 Indicates filter corresponding to each section of logical operation. NEC Corporation /91

29 arf:functionfilter Definition Super Class: arf:filter It is a super class of filter group, which has features with conditions attached by function. In, relative position from resource/literal Entity, which is the evaluation target of filter, is specified in arf:evaluates by Reference Model Node. Reference Model Node is an URI for specifying each node inside Reference Model defined by DSM. Filter interpreter resolves resource and literal of evaluation target by referring to the Reference Model defined by DSM on the basis of this URI. Resource URI Meaning: It is a URI for distinguishing arf:functionfilter resource in this operation. Uniqueness: message unique list Range Cardinality Description arf:evaluates Reference Model Node URI 0..*:1 Indicates the resource and the literal, which are the evaluation target of this resource, by Reference Model Node URI. arf:orderby Definition Super Class: arf:functionfilter Overview It is a class for specifying sorting method (ascending/descending) and scope, desired as result after alignment. Entity is sorted by taking Literal, which is specified as Reference Model URI in arf:evaluates, as evaluation value. Selection by ascending and descending is carried out by arf:orderproperty. After sorting Entity, Entity from arf:from to arf:to is taken as result. Here, if arf:from is specified, abf:offset of abf:entities, which is to be taken care, matches with arf:fromvalue. Comparison rule Comparison for ascending and descending is as per the below mentioned table. Reference Model Node Target type Comparison method Remarks rdfs:literal Optional resource xsd:integer xsd:long xsd:float xsd:double xsd:datetime Other above Optional resource than Compare numerical value Compare numerical value Compare numerical value Compare numerical value Compare date Not defined Not defined Defined in DSM Defined in DSM Resource URI Meaning: It is a URI for distinguishing arf:orderby resource in this operation. Uniqueness: message unique NEC Corporation /91

30 list Range Cardinality Description arf:evaluates Reference Model Node URI 0..*:1 Indicates resource/literal, which is evaluation target value, at the time of carrying out sorting by Reference Model Node URI. arf:order arf:order 0..*:1 Indicates ascending and descending. Ascending in case of arf:ascending. Descending in case of arf:descending. arf:from arf:to rdfs:literal (xsd:integer) rdfs:literal (xsd:integer) 0..1:1 Indicates the begin value for the ranged Entity, which is desired as result after the sorting of Entity. Value 1 or more is taken. 0..1:1 Indicates the end value for the ranged Entity, which is desired as result, after the sorting of Entity. Value more than value specified by 1 and arf:from is taken. arf:datafilter Definition Super Class: arf:filter It is a super class of filter group, which compares Literal value. The location (relative location from Entity) of evaluation target of filter is specified by arf:evaluates. Reference Model Node URI is the URI for specifying each node inside Reference Model defined by DSM. The filter interpreter resolves Literal of evaluation target by referring to Reference model defined by DSM on the basis of this URI. Resource URI Meaning: It is a URI for distinguishing arf:datafilter resource in this operation. Uniqueness: message unique list Range Cardinality Description arf:evaluates Reference Model Node URI 0..*:1 Indicates literal, which is an evaluation target of this filter, by Reference Model Node URI. arf:equals Definition Super Class: arf:datafilter Overview It is a filter, which matches and compares Literal value. This filter decides whether the value of Entity instance of literal, which is a comparison target specified by arf:evaluates, matches with Literal value specified by arf:value. Data type is compared by interpreting it as the data type specified by arf:valueliteral in the value of comparison. Comparison rule The comparison rule is as per the table below. Reference Model Node Target type Comparison method Remarks rdfs:literal xsd:short xsd:integer xsd:long xsd:float xsd:double xsd:datetime Compare numerical value Compare numerical value Compare numerical value Compare numerical value Compare numerical value Compare date NEC Corporation /91

31 xsd:boolean Compare true value xsd:string Compare string Match completely Other than above mentioned Not defined Defined in DSM Resource URI Meaning: It is an URI for distinguishing arf:equals resource in this operation. Uniqueness: message unique list Range Cardinality Description arf:value rdfs:literal 1:1 Literal value to be compared arf:evaluates See arf:datafilter See arf:datafilter <Inherit from arf:datafilter>indicates the literal of evaluation target by Reference Model Node URI. arf:ranges Definition Super Class: arf:datafilter Overview It is a filter to compare the range of Literal value. It determines whether the value in Entity instance of Literal, which is the target of evaluation specified by arf:evaluates, is to be included in the range of Literal values specified by arf:begin and arf:end. In the comparison of Literal value, comparison is carried out by interpreting that data type is the one, which is specified by arf:begin and/or arf:end. Comparison rule Comparison rule is as per the below mentioned table. Reference Model Node Target type Comparison method Remarks rdfs:literal xsd:short xsd:integer xsd:long xsd:float xsd:double xsd:datetime Other than above mentioned Compare numerical value Compare numerical value Compare numerical value Compare numerical value Compare numerical value Compare date Not defined Defined in DSM Resource URI Meaning: It is an URI for distinguishing arf:ranges resources in this operation. Uniqueness: message unique list Range Cardinality Description arf:begin rdfs:literal 1:0..1 Begin value for the ranged Literal values arf:includebegin rdfs:literal (xsd:boolean) 1:0..1 (If arf:begin is configured 1:1) Whether to include begin value in the ranged Literal values or not. In case of true, include arf:begin in the range. arf:end rdfs:literal 1:0..1 End value for the ranged Literal values arf:includeend rdfs:literal (xsd:boolean) 1:0..1 (If arf:end is Whether to include end value in the ranged Literal values or not. In case of true, include arf:end in the NEC Corporation /91

32 configured 1:1) range. arf:evaluates See arf:datafilter See arf:datafilter <Inherit from arf:datafilter>indicates Literal of evaluation target by Reference Model Node URI. arf:similarto Definition Super Class: arf:datafilter It is a filter to compare similarity of Literal value. It determines whether the value in Entity instance of Literal, which is the target of evaluation specified by arf:evaluates, is similar to Literal value, specified by arf:value, or not. The algorithm of similarity comparison is defined in DSM, which defined each data. In the comparison of Literal value, comparison is carried out by interpreting the data type as the one, which is specified by arf:value. Comparison rule The comparison rule is as per the below mentioned table. Reference Model Node rdfs:literal Target type Comparison method Remarks xsd:short xsd:integer xsd:long xsd:float xsd:double xsd:string Value close to numerical. The value of range (value of arf:value ± value of arf:value arf:similarity value) is considered similar. Value close to numerical. The value of range (value of arf:value ± value of arf:value arf:similarity value) is considered similar. Value close to numerical. The value of range (value of arf:value ± value of arf:value arf:similarity value) is considered similar. Value close to numerical. The value of range (value of arf:value ± value of arf:value arf:similarity value) is considered similar. Value close to numerical. The value of range (value of arf:value ± value of arf:value arf:similarity value) is considered as similar. Edit distance (distance between strings considering insertion of character unit, modification and deletion) is the value close to numerical. If range is (character count of arf:value + character count of arf:value arf:similarity value), it is considered similar. Resource URI Meaning: It is an URI for distinguishing arf:similarto resources in this operation. Uniqueness: message unique list Range Cardinality Description arf:value rdfs:literal 1:1 Literal value to be compared arf:similarity rdfs:literal (xsd:double) 1:1 Degree of similarity at the time of comparison NEC Corporation /91

33 arf:evaluates See arf:datafilter See arf:datafilter <Inherit from arf:datafilter> Literal, which is the target of comparison, is specified by Reference Model Node URI. arf:contains Definition Super Class: arf:datafilter Overview It is a filter, which compares content of Literal value. The behavior of this filter is divided into two depending on whether the comparison target specified by arf:evaluates is Literal or rdf:container. 1. If comparison target specified by arf:evaluates is Literal The content relation of string is compared considering Literal value of Entity instance, which corresponds to Literal specified by arf:evaluates, as string. 2. If comparison target specified by arf:evaluates, is rdf:container or its subclass It is evaluated whether element which matches with Literal value specified by arf:value and Literal value of element inside container is included in that container or not. In the comparison of Literal value, comparison is carried out by interpreting data type as the one specified by arf:value. Comparison rule If comparison target specified by arf:evaluates is Literal, comparison rule is as per the below mentioned table. Reference Model Node Target type Comparison method Remarks rdfs:literal xsd:string Other than above mentioned Whether string of arf:value is included or not in the string of comparison target as part string Not defined Defined in DSM If comparison target specified by arf:evaluates is rdf:container, comparison rule is as per the below mentioned table. Reference Model Node Target type Comparison method Remarks rdfs:literal xsd:short xsd:integer xsd:long xsd:float xsd:double xsd:datetime xsd:boolean xsd:string Other than above mentioned Compare numerical value Compare numerical value Compare numerical value Compare numerical value Compare numerical value Compare date Compare true value Compare string Not defined Defined in DSM Resource URI Meaning: It is an URI for distinguishing arf:contains resources in this operation. Uniqueness: message unique list NEC Corporation /91