/branches/green/json-rdf/src/main/java/com/epimorphics/vocabs/API.java

https://bitbucket.org/pombredanne/linked-data-api-treemap · Java · 167 lines · 47 code · 43 blank · 77 comment · 0 complexity · 7eda618a3c8c0a57afdb4b91c1fa58f1 MD5 · raw file 

    

  1. /* CVS $Id: $ */
    2. 

  2. package com.epimorphics.vocabs; 
    3. 

  3. import com.hp.hpl.jena.rdf.model.*;
    4. 

  4. import com.hp.hpl.jena.ontology.*;
    5. 

  5.  
    6. 

  6. /**
    7. 

  7.  * Vocabulary definitions from src/main/vocabs/api.ttl 
    8. 

  8.  * @author Auto-generated by schemagen on 14 Feb 2010 16:00 
    9. 

  9.  */
    10. 

  10. public class API {
    11. 

  11.     /** <p>The ontology model that holds the vocabulary terms</p> */
    12. 

  12.     private static OntModel m_model = ModelFactory.createOntologyModel( OntModelSpec.OWL_MEM, null );
    13. 

  13.     
    14. 

  14.     /** <p>The namespace of the vocabulary as a string</p> */
    15. 

  15.     public static final String NS = "http://www.epimorphics.com/vocabularies/api#";
    16. 

  16.     
    17. 

  17.     /** <p>The namespace of the vocabulary as a string</p>
    18. 

  18.      *  @see #NS */
    19. 

  19.     public static String getURI() {return NS;}
    20. 

  20.     
    21. 

  21.     /** <p>The namespace of the vocabulary as a resource</p> */
    22. 

  22.     public static final Resource NAMESPACE = m_model.createResource( NS );
    23. 

  23.     
    24. 

  24.     /** <p>designates the (potentially) ordered set of results within this page of the 
    25. 

  25.      *  whole results set</p>
    26. 

  26.      */
    27. 

  27.     public static final ObjectProperty contains = m_model.createObjectProperty( "http://www.epimorphics.com/vocabularies/api#contains" );
    28. 

  28.     
    29. 

  29.     /** <p>points to a viewer which should be used as the default view filter</p> */
    30. 

  30.     public static final ObjectProperty defaultViewer = m_model.createObjectProperty( "http://www.epimorphics.com/vocabularies/api#defaultViewer" );
    31. 

  31.     
    32. 

  32.     /** <p>indicates a query endpoint provided by this API</p> */
    33. 

  33.     public static final ObjectProperty endpoint = m_model.createObjectProperty( "http://www.epimorphics.com/vocabularies/api#endpoint" );
    34. 

  34.     
    35. 

  35.     /** <p>indicates a URL from which the content of this List/Set can be obtained</p> */
    36. 

  36.     public static final ObjectProperty listURL = m_model.createObjectProperty( "http://www.epimorphics.com/vocabularies/api#listURL" );
    37. 

  37.     
    38. 

  38.     /** <p>indicates a URL from which the specification of this view can be obtained</p> */
    39. 

  39.     public static final ObjectProperty metaURL = m_model.createObjectProperty( "http://www.epimorphics.com/vocabularies/api#metaURL" );
    40. 

  40.     
    41. 

  41.     /** <p>gives a selector from which selector should inherit</p> */
    42. 

  42.     public static final ObjectProperty parent = m_model.createObjectProperty( "http://www.epimorphics.com/vocabularies/api#parent" );
    43. 

  43.     
    44. 

  44.     /** <p>points to a single prefix/namespace binding to use in embedded queries</p> */
    45. 

  45.     public static final ObjectProperty prefixMaping = m_model.createObjectProperty( "http://www.epimorphics.com/vocabularies/api#prefixMaping" );
    46. 

  46.     
    47. 

  47.     /** <p>gives a property to include in the templated view</p> */
    48. 

  48.     public static final ObjectProperty properties = m_model.createObjectProperty( "http://www.epimorphics.com/vocabularies/api#properties" );
    49. 

  49.     
    50. 

  50.     /** <p>points to the specification for which resources to include in the data view</p> */
    51. 

  51.     public static final ObjectProperty selector = m_model.createObjectProperty( "http://www.epimorphics.com/vocabularies/api#selector" );
    52. 

  52.     
    53. 

  53.     /** <p>indicates the SPARQL endpoint to be used for an API</p> */
    54. 

  54.     public static final ObjectProperty sparqlEndpoint = m_model.createObjectProperty( "http://www.epimorphics.com/vocabularies/api#sparqlEndpoint" );
    55. 

  55.     
    56. 

  56.     /** <p>indicates the class of the resources which make up this set/list</p> */
    57. 

  57.     public static final ObjectProperty type = m_model.createObjectProperty( "http://www.epimorphics.com/vocabularies/api#type" );
    58. 

  58.     
    59. 

  59.     /** <p>points to a viewer defining the set of properties to include in the view (can 
    60. 

  60.      *  be given in a query using _viewer)</p>
    61. 

  61.      */
    62. 

  62.     public static final ObjectProperty viewer = m_model.createObjectProperty( "http://www.epimorphics.com/vocabularies/api#viewer" );
    63. 

  63.     
    64. 

  64.     /** <p>reference to a vocabulary (aka ontology) resource which may contain annotations 
    65. 

  65.      *  to help with serialization and API access</p>
    66. 

  66.      */
    67. 

  67.     public static final ObjectProperty vocabulary = m_model.createObjectProperty( "http://www.epimorphics.com/vocabularies/api#vocabulary" );
    68. 

  68.     
    69. 

  69.     /** <p>gives a short name which can be used for any class or property</p> */
    70. 

  70.     public static final DatatypeProperty label = m_model.createDatatypeProperty( "http://www.epimorphics.com/vocabularies/api#label" );
    71. 

  71.     
    72. 

  72.     /** <p>gives the namespace part of a prefix mapping, as a plain string</p> */
    73. 

  73.     public static final DatatypeProperty namespace = m_model.createDatatypeProperty( "http://www.epimorphics.com/vocabularies/api#namespace" );
    74. 

  74.     
    75. 

  75.     /** <p>gives a default ordering for the list, can be a prop, prop chain optionally 
    76. 

  76.      *  followed by - to indicate descending (can be given in a query using _orderby=spec)</p>
    77. 

  77.      */
    78. 

  78.     public static final DatatypeProperty orderby = m_model.createDatatypeProperty( "http://www.epimorphics.com/vocabularies/api#orderby" );
    79. 

  79.     
    80. 

  80.     /** <p>gives the number of the page within parent list</p> */
    81. 

  81.     public static final DatatypeProperty page = m_model.createDatatypeProperty( "http://www.epimorphics.com/vocabularies/api#page" );
    82. 

  82.     
    83. 

  83.     /** <p>gives the number of items per page</p> */
    84. 

  84.     public static final DatatypeProperty pageSize = m_model.createDatatypeProperty( "http://www.epimorphics.com/vocabularies/api#pageSize" );
    85. 

  85.     
    86. 

  86.     public static final DatatypeProperty paramVar = m_model.createDatatypeProperty( "http://www.epimorphics.com/vocabularies/api#paramVar" );
    87. 

  87.     
    88. 

  88.     /** <p>gives the prefix part of a prefix mapping, as a plain string</p> */
    89. 

  89.     public static final DatatypeProperty prefix = m_model.createDatatypeProperty( "http://www.epimorphics.com/vocabularies/api#prefix" );
    90. 

  90.     
    91. 

  91.     /** <p>gives a query filter in the same syntax as request queries, supported syntax 
    92. 

  92.      *  includes - property=value - prop1.prop2. ... propn=value - name-prop=value 
    93. 

  93.      *  (equivalent to prop.rdfs_label=value) - min-prop=value (matches greater than 
    94. 

  94.      *  or equal to value) - minO-prop=value (open min, matches greater than or value) 
    95. 

  95.      *  - max-prop=value (matches less than or equal to value) - maxO-prop=value (open 
    96. 

  96.      *  max, matches less than value)</p>
    97. 

  97.      */
    98. 

  98.     public static final DatatypeProperty query = m_model.createDatatypeProperty( "http://www.epimorphics.com/vocabularies/api#query" );
    99. 

  99.     
    100. 

  100.     public static final DatatypeProperty resourceVar = m_model.createDatatypeProperty( "http://www.epimorphics.com/vocabularies/api#resourceVar" );
    101. 

  101.     
    102. 

  102.     /** <p>gives the query that is run to find entries in this list</p> */
    103. 

  103.     public static final DatatypeProperty sparqlQuery = m_model.createDatatypeProperty( "http://www.epimorphics.com/vocabularies/api#sparqlQuery" );
    104. 

  104.     
    105. 

  105.     /** <p>indicates the URI for the API endpoint, relative to the server base</p> */
    106. 

  106.     public static final DatatypeProperty uri = m_model.createDatatypeProperty( "http://www.epimorphics.com/vocabularies/api#uri" );
    107. 

  107.     
    108. 

  108.     /** <p>indicates the URI or URI template for the API endpoint, relative to the server 
    109. 

  109.      *  base</p>
    110. 

  110.      */
    111. 

  111.     public static final DatatypeProperty uriTemplate = m_model.createDatatypeProperty( "http://www.epimorphics.com/vocabularies/api#uriTemplate" );
    112. 

  112.     
    113. 

  113.     /** <p>gives a SPARQL WHERE clause (GroupGraphPattern excluding {}) to filter the 
    114. 

  114.      *  view (can be given in the query using _where)</p>
    115. 

  115.      */
    116. 

  116.     public static final DatatypeProperty where = m_model.createDatatypeProperty( "http://www.epimorphics.com/vocabularies/api#where" );
    117. 

  117.     
    118. 

  118.     /** <p>an API resource binds a set of related views to a SPARQL endpoint, also providing 
    119. 

  119.      *  cross-api settings</p>
    120. 

  120.      */
    121. 

  121.     public static final OntClass API = m_model.createClass( "http://www.epimorphics.com/vocabularies/api#API" );
    122. 

  122.     
    123. 

  123.     /** <p>a viewer which provides a full DESCRIBE of each resource, where the semantics 
    124. 

  124.      *  of DESCRIBE is defined by the underlying sparqlEndpoint</p>
    125. 

  125.      */
    126. 

  126.     public static final OntClass DescribeViewer = m_model.createClass( "http://www.epimorphics.com/vocabularies/api#DescribeViewer" );
    127. 

  127.     
    128. 

  128.     /** <p>a particular query endpoint within an API, represents a List or Set of resources 
    129. 

  129.      *  selected from the bound SPARQL endpoint</p>
    130. 

  130.      */
    131. 

  131.     public static final OntClass Endpoint = m_model.createClass( "http://www.epimorphics.com/vocabularies/api#Endpoint" );
    132. 

  132.     
    133. 

  133.     /** <p>class used to mark properties that should not be included in serialization</p> */
    134. 

  134.     public static final OntClass Hidden = m_model.createClass( "http://www.epimorphics.com/vocabularies/api#Hidden" );
    135. 

  135.     
    136. 

  136.     /** <p>an API Endpoint representing a single resource</p> */
    137. 

  137.     public static final OntClass ItemEndpoint = m_model.createClass( "http://www.epimorphics.com/vocabularies/api#ItemEndpoint" );
    138. 

  138.     
    139. 

  139.     /** <p>an API Endpoint representing and ordered list of resources</p> */
    140. 

  140.     public static final OntClass ListEndpoint = m_model.createClass( "http://www.epimorphics.com/vocabularies/api#ListEndpoint" );
    141. 

  141.     
    142. 

  142.     /** <p>class used to mark properties that should be serialized as if they are multivalued, 
    143. 

  143.      *  irrespective of their cardinality on any particular instance</p>
    144. 

  144.      */
    145. 

  145.     public static final OntClass Multivalued = m_model.createClass( "http://www.epimorphics.com/vocabularies/api#Multivalued" );
    146. 

  146.     
    147. 

  147.     /** <p>represents a page of results from a (possibly large) results document</p> */
    148. 

  148.     public static final OntClass Page = m_model.createClass( "http://www.epimorphics.com/vocabularies/api#Page" );
    149. 

  149.     
    150. 

  150.     /** <p>Represents a single prefix/namespace pair</p> */
    151. 

  151.     public static final OntClass PrefixMapping = m_model.createClass( "http://www.epimorphics.com/vocabularies/api#PrefixMapping" );
    152. 

  152.     
    153. 

  153.     /** <p>A Selector specifies which resources match the query</p> */
    154. 

  154.     public static final OntClass Selector = m_model.createClass( "http://www.epimorphics.com/vocabularies/api#Selector" );
    155. 

  155.     
    156. 

  156.     /** <p>a viewer which uses a template, defined by a set of property (paths), to filter 
    157. 

  157.      *  the view</p>
    158. 

  158.      */
    159. 

  159.     public static final OntClass TemplateViewer = m_model.createClass( "http://www.epimorphics.com/vocabularies/api#TemplateViewer" );
    160. 

  160.     
    161. 

  161.     /** <p>defines a (possibly named) subset of properties on list entries which should 
    162. 

  162.      *  be included in the returned model (named viewers can be invoked in a query 
    163. 

  163.      *  using _show)</p>
    164. 

  164.      */
    165. 

  165.     public static final OntClass Viewer = m_model.createClass( "http://www.epimorphics.com/vocabularies/api#Viewer" );
    166. 

  166.     
    167. 

  167. }
    168.