Apache Jena

https://jena.apache.org/documentation
Admin
Apache Jena is a free and open-source Java framework for building Semantic Web applications,...
Tokens:3,846,894
Snippets:32,774
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Example of installing a specific path (Java)

Source: https://jena.apache.org/documentation/query/property_paths.html

Provides a concrete example of parsing the 'rdf:type/rdfs:subClassOf*' path and installing it with a custom URI.

```java
Path path = PathParser.parse("rdf:type/rdfs:subClassOf*", PrefixMapping.Standard) ;
String uri = "http://example/ns#myType" ;
PathLib.install(uri, path) ;

```

--------------------------------

### start

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/main/FusekiServer.Builder.html

Builds the server according to the current description and then starts it. This is a shortcut method for building and immediately starting the server.

```APIDOC
## start

### Description
Builds the server according to the current description and then starts it. This is a shortcut method for building and immediately starting the server.

### Method
public FusekiServer start()

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
Returns the started `FusekiServer` instance.

### Response Example
None
```

--------------------------------

### start Method

Source: https://jena.apache.org/documentation/javadoc/arq/org.apache.jena.arq/org/apache/jena/system/progress/ProgressMonitorOutput.html

Starts the progress monitor and begins timing.

```APIDOC
## start()

### Description
Starts the progress monitoring process and initiates timing. This method should be paired with a call to `finish()` to properly track the duration of an operation.
```

--------------------------------

### Main Method Example

Source: https://jena.apache.org/documentation/javadoc/extras/serviceenhancer/org.apache.jena.serviceplugins/org/apache/jena/sparql/service/enhancer/example/ServicePluginExamples.html

The main entry point for running service enhancer examples.

```Java
public static void main(String[] args)
```

--------------------------------

### Example LET Assignment

Source: https://jena.apache.org/documentation/query/assignment.html

An example demonstrating the LET assignment syntax.

```sparql
LET ( ?x := 2 )
```

--------------------------------

### start Method

Source: https://jena.apache.org/documentation/javadoc/rdfpatch/org.apache.jena.rdfpatch/org/apache/jena/rdfpatch/changes/RDFChangesOnStartFinish.html

Starts the RDF change processing, executing the onStart callback.

```APIDOC
## start()

### Description
Starts processing. This method should be paired with a `finish()` call. It executes the `onStart` Runnable provided during construction.

### Method
void

### Overrides
`start` in class `RDFChangesWrapper`

### Implements
`start` in interface `RDFChanges`
```

--------------------------------

### void start()

Source: https://jena.apache.org/documentation/javadoc/arq/org.apache.jena.arq/org/apache/jena/riot/system/StreamRDF.html

Signals the start of the RDF processing stream.

```APIDOC
## void start()

### Description
Signals the start of the RDF processing stream.
```

--------------------------------

### start Method

Source: https://jena.apache.org/documentation/javadoc/arq/org.apache.jena.arq/org/apache/jena/sparql/core/describe/DescribeBNodeClosure.html

Starts the describe process, passing in the result model and query execution context.

```APIDOC
## start(Model accumulateResultModel, Context cxt)

### Description
Start the describe process, passing in the result model.

### Method
`void start(org.apache.jena.rdf.model.Model accumulateResultModel, Context cxt)`

### Parameters
* `accumulateResultModel` (Model) - The model to accumulate results.
* `cxt` (Context) - Query execution context.
```

--------------------------------

### Example Statistics File

Source: https://jena.apache.org/documentation/tdb/optimizer.html

A concrete example of a statistics file with metadata and predicate counts.

```sse
(prefix ((: <http://example/>))
  (stats
    (meta
      (timestamp "2008-10-23T10:35:19.122+01:00"^^<http://www.w3.org/2001/XMLSchema#dateTime>)
      (run@ "2008/10/23 10:35:19")
      (count 11))
    (:p 7)
    (<http://example/q> 7)
  ))

```

--------------------------------

### Create and Start a FusekiServer

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/main/FusekiServer.html

Use the builder pattern to configure and start a Fuseki server with a specific port and dataset.

```java
      DatasetGraph dsg = ...;
      FusekiServer server = FusekiServer.create()
          .port(1234)
          .add("/ds", dsg)
          .build();
       server.start();
```

--------------------------------

### Main Method for Jena Text Example

Source: https://jena.apache.org/documentation/javadoc/text/org.apache.jena.text/examples/text/JenaTextExample1.html

The entry point for the example. It orchestrates the creation, loading, and querying of the text search dataset.

```Java
public static void main(String... argv) {
    org.apache.jena.query.Dataset dataset = createAssembler();
    loadData(dataset, "data.ttl");
    queryData(dataset);
}
```

--------------------------------

### JettyServer Start

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/main/JettyServer.html

Starts the Jetty server. The server will continue to run after this method returns. Call `join()` to synchronize with the server's lifecycle.

```APIDOC
## start

### Description
Starts the Jetty server. The server operates asynchronously after this call returns. To wait for the server to stop, use the `join()` method.

### Method
`JettyServer`

### Signature
`public JettyServer start()`
```

--------------------------------

### setup()

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/mgt/FusekiServerCtl.html

Initializes the Fuseki server environment if it has not been formatted yet.

```APIDOC
## setup()

### Description
Sets up the Fuseki server's file areas and configuration if they do not already exist.

### Method
`public void setup()`
```

--------------------------------

### Implementing execGet in ActionBase

Source: https://jena.apache.org/documentation/javadoc/fuseki2/org.apache.jena.fuseki.core/org/apache/jena/fuseki/servlets/ActionBase.html

Example of overriding execGet to trigger the standard lifecycle execution for a GET request.

```java
 public void execGet(HttpAction action) { super.executeLifecycle(action); }
```

--------------------------------

### getOffsetInRanges

Source: https://jena.apache.org/documentation/javadoc/extras/serviceenhancer/org.apache.jena.serviceplugins/org/apache/jena/sparql/service/enhancer/slice/impl/RangeBuffer.html

Gets the offset within the range set where this buffer starts. Returns null if the offset cannot be represented in a single value.

```APIDOC
## getOffsetInRanges

### Description
The offset within the range set where this buffer starts; may be null if the offset cannot be represented in a single value such as in a union of two buffers which have different offsets.

### Method
`getOffsetInRanges()`

### Return Type
`Long`
```

--------------------------------

### begin()

Source: https://jena.apache.org/documentation/javadoc/arq/index-all.html

Starts a transaction in READ mode, which may switch to WRITE if an update is attempted, provided no intermediate transaction has performed an update.

```APIDOC
## void begin()

### Description
Starts a transaction which is READ mode and which will switch to WRITE if an update is attempted but only if no intermediate transaction has performed an update.
```

--------------------------------

### get(int index)

Source: https://jena.apache.org/documentation/javadoc/ontapi/org.apache.jena.ontapi/org/apache/jena/ontapi/impl/objects/OntListImpl.html

Answers the list that is the tail of this list starting from the given position. This method can be used to insert/remove/clear the parent list at any position.

```APIDOC
## get(int index)

### Description
Answers the list that is the tail of this list starting from the given position. Note: the returned list cannot be annotated. This method can be used to insert/remove/clear the parent list at any position, e.g. the operation `get(1).addFirst(e)` will insert the element `e` at second position.

### Method
public OntList<E> get(int index) throws org.apache.jena.shared.PropertyNotFoundException, OntJenaException.IllegalArgument

### Parameters
#### Path Parameters
- **index** (int) - Required - not negative

### Returns
new `OntList` instance

### Throws
- `OntJenaException.IllegalArgument` - if the specified index is out of list bounds
- `org.apache.jena.shared.PropertyNotFoundException`
```

--------------------------------

### Start Fuseki with Configuration File

Source: https://jena.apache.org/documentation/fuseki2/fuseki-data-access-control.html

Command to launch the Fuseki server using a specific configuration file.

```bash
$ fuseki --conf configFile.ttl
```

--------------------------------

### Example Property Function Implementation

Source: https://jena.apache.org/documentation/query/writing_propfuncs.html

A basic implementation of a Property Function that returns no results. This serves as a starting point for creating custom property functions.

```java
public class ExamplePropertyFunctionFactory implements PropertyFunctionFactory {
	@Override
	public PropertyFunction create(final String uri)
	{
		return new PFuncSimple()
		{
			@Override
			public QueryIterator execEvaluated(final Binding parent, final Node subject, final Node predicate, final Node object, final ExecutionContext execCtx)
			{
                return QueryIterNullIterator.create(execCtx);
			}
		};
	}
}
```

--------------------------------

### FusekiServer.Builder.start()

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/index-all.html

Builds and starts the Fuseki server instance.

```APIDOC
## Method: start()

### Description
Shortcut method to build and then start the Fuseki server.

### Signature
`void start()`
```

--------------------------------

### Example RDF Patch with Prefixes and Triples

Source: https://jena.apache.org/documentation/rdf-patch/index.html

This snippet demonstrates how to ensure specific prefixes are present and add basic triples for a new subclass. It includes transaction start and commit markers.

```turtle
TX .
PA "rdf" "http://www.w3.org/1999/02/22-rdf-syntax-ns#" .
PA "owl" "http://www.w3.org/2002/07/owl#" .
PA "rdfs" "http://www.w3.org/2000/01/rdf-schema#" .
A <http://example/SubClass> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://www.w3.org/2002/07/owl#Class> .
A <http://example/SubClass> <http://www.w3.org/2000/01/rdf-schema#subClassOf> <http://example/SUPER_CLASS> .
A <http://example/SubClass> <http://www.w3.org/2000/01/rdf-schema#label> "SubClass" .
TC .
```

--------------------------------

### FusekiServer.start()

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/main/FusekiServer.html

Starts the server instance.

```APIDOC
## FusekiServer.start()

### Description
Starts the server. The server continues to run in the background after this call returns.
```

--------------------------------

### Get Zero or One Labels for Each Subject

Source: https://jena.apache.org/documentation/query/lateral-join.html

This example uses `LATERAL` with an `OPTIONAL` block inside to retrieve at most one label for any subject. If no label is found, the subject is still included in the results.

```sparql
SELECT * {
  ?s ?p ?o
  LATERAL {
    OPTIONAL {
      SELECT * { ?s rdfs:label ?label } LIMIT 1
    }
  }
}
```

--------------------------------

### FusekiServer construct(FusekiModules fusekiModules, String... args)

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/main/FusekiMain.html

Builds a Fuseki server instance with specified modules and command-line arguments, without starting it. Facilitates custom server setups.

```APIDOC
## construct(FusekiModules fusekiModules, String... args)

### Description
Build, but do not start, a server based on modules and the command line syntax.

### Method
`public static FusekiServer construct(FusekiModules fusekiModules, String... args)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
FusekiModules modules = ...; // Initialize your FusekiModules
FusekiServer server = FusekiMain.construct(modules, "--port=0");
```

### Response
#### Success Response (200)
`FusekiServer` - A configured server instance with specified modules, not yet started.
```

--------------------------------

### main

Source: https://jena.apache.org/documentation/javadoc/arq/org.apache.jena.arq/org/apache/jena/ext/xerces_regex/REUtil.html

A sample entry point for demonstrating the usage of REUtil methods. It expects a regex and a string as command-line arguments.

```APIDOC
## main

### Description
Sample entry point for demonstrating REUtil functionality.

### Method Signature
`public static void main(String[] argv)`

### Usage
`org.apache.jena.ext.xerces_regex.REUtil <regex> <string>`
```

--------------------------------

### FusekiServer.start

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/main/FusekiServer.html

Starts the server instance.

```APIDOC
## public FusekiServer start()

### Description
Start the server - the server continues to run after this call returns. To synchronise with the server stopping, call join().
```

--------------------------------

### Fuseki Server Configuration via Command Line

Source: https://jena.apache.org/documentation/query/javascript-functions.html

Demonstrates how to start a Fuseki server with JavaScript scripting enabled and a specific function allowed. The `arq:js-library` and `arq:scriptAllowList` context parameters are used.

```bash
export JVM_ARGS=-Djena:scripting=true
fuseki --set arq:js-library=functions.js \
       --set arq:scriptAllowList=toCamelCase \
       --mem /ds

```

--------------------------------

### Get Property

Source: https://jena.apache.org/documentation/javadoc/ontapi/org.apache.jena.ontapi/org/apache/jena/ontapi/impl/objects/OntClassImpl.DataSomeValuesFromImpl.html

Gets the property associated with this restriction.

```APIDOC
## Method: getProperty

### Description
Gets the property, that this `OntClass.UnaryRestriction` has inside its RDF structure on predicate `owl:onProperty`.

### Returns
`OntDataProperty` - The associated property.
```

--------------------------------

### get

Source: https://jena.apache.org/documentation/javadoc/extras/serviceenhancer/org.apache.jena.serviceplugins/org/apache/jena/sparql/service/enhancer/claimingcache/RefImpl.html

Gets the referent if the reference is alive and not closed.

```APIDOC
## get

### Description
Gets the referent only if this ref instance has not yet been closed. This method fails for closed alive refs. A closed reference is alive if it has unclosed child references. For most use cases the referent should be accessed using this method.

### Specified by
`get` in interface `Ref<T>`

### Returns
- **T** - The referent.
```

--------------------------------

### Get Subclasses (Direct or All) - OntSimpleClassImpl

Source: https://jena.apache.org/documentation/javadoc/ontapi/org.apache.jena.ontapi/org/apache/jena/ontapi/impl/objects/OntSimpleClassImpl.html

Retrieves a stream of subclasses for this class. Set 'direct' to true to get only immediate subclasses, or false to get all subclasses in the hierarchy.

```java
public Stream<OntClass> subClasses(boolean direct)
Description copied from interface: OntClass
Answers a Stream over all the class expressions that are declared to be subclasses of this class expression. The return Stream is distinct and this instance is not included in it. The flag direct allows some selectivity over the classes that appear in the Stream. Consider the following scenario: 

```

--------------------------------

### Run Fuseki Plain Server with Help

Source: https://jena.apache.org/documentation/fuseki2/fuseki-plain.html

Execute the Fuseki plain server JAR with the --help argument to display available command-line options. This is useful for understanding the server's configuration and operational parameters.

```bash
java -cp jena-fuseki-server-$VER.jar org.apache.jena.fuseki.main.cmds.FusekiMainCmd --help

```

--------------------------------

### Get Superclasses (Direct or All) - OntSimpleClassImpl

Source: https://jena.apache.org/documentation/javadoc/ontapi/org.apache.jena.ontapi/org/apache/jena/ontapi/impl/objects/OntSimpleClassImpl.html

Retrieves a stream of superclasses for this class. Set 'direct' to true to get only immediate superclasses, or false to get all superclasses in the hierarchy.

```java
public Stream<OntClass> superClasses(boolean direct)
Description copied from interface: OntClass
Answers a Stream over the class-expressions for which this class expression is declared a subclass. The return Stream is distinct and this instance is not included in it. 
The flag direct allows some selectivity over the classes that appear in the Stream. Consider the following scenario: 

   :A rdfs:subClassOf :B .
   :A rdfs:subClassOf :C .
   :C rdfs:subClassOf :D . 

(so A has superclasses B and C, and C has superclass D) In a raw model, with no inference support, listing the superclasses of A will answer B and C. In an inferencing model, rdfs:subClassOf is known to be transitive, so the superclasses iterator will include D. The direct superclasses are those members of the closure of the inverse-subClassOf relation, restricted to classes that cannot be reached by a longer route, i.e., the ones that are _directly_ adjacent to the given root. Thus, the direct superclasses of A are B and C only, and not D - even in an inferencing graph. Note that this is not the same as the entailments from the raw graph. Suppose we add to this example:

   :A rdfs:subClassOf :D . 

Now, in the raw graph, A has superclasses B, C, D. But the direct superclasses of A remain only B and C, since there is a longer path A-C-D that means that D is not a direct superclass of A. The assertion in the raw graph that A has superclass D is essentially redundant, since this can be inferred from the closure of the graph. 

Specified by:
    superClasses in interface OntClass 

Parameters:
    direct - boolean: if true answers the directly adjacent classes in the superclass relation, i.e., eliminate any class for which there is a longer route to reach that parent under the superclass relation; if false answers all superclasses found by inferencer, which usually means entire hierarchy up the tree; this class is not included 

Returns:
    distinct Stream of super class expression

See Also:
    
      * OntClass.superClasses()
      * OntClass.subClasses(boolean)
    
```

--------------------------------

### Example Rule File with Directives

Source: https://jena.apache.org/documentation/inference

Demonstrates a complete rule file including RDFS rules and a custom rule, using @prefix and @include directives.

```plaintext
# ...
    A comment line.

// ...
    A comment line.  
  


@prefix pre: <http://domain/url#>.
    Defines a prefix `pre` which can be used in the rules. The prefix is local to the rule file.
  

@include <urlToRuleFile>.
    Includes the rules defined in the given file in this file. The included rules will appear before the user defined rules, irrespective of where in the file the @include directive appears. A set of special cases is supported to allow a rule file to include the predefined rules for RDFS and OWL - in place of a real URL for a rule file use one of the keywords `RDFS` `OWL` `OWLMicro` `OWLMini` (case insensitive).
So an example complete rule file which includes the RDFS rules and defines a single extra rule is:

```

--------------------------------

### start

Source: https://jena.apache.org/documentation/javadoc/rdfpatch/org.apache.jena.rdfpatch/org/apache/jena/rdfpatch/changes/RDFChangesApply.html

Starts processing. This method should be paired with a finish() call.

```APIDOC
## start()

### Description
Start processing. The exact meaning is implementation dependent. This should be paired with a `finish()`.

### Method
`void start()`

### Specified by:
`start` in interface `RDFChanges`
```

--------------------------------

### init

Source: https://jena.apache.org/documentation/javadoc/arq/org.apache.jena.arq/org/apache/jena/sparql/core/assembler/AssemblerUtils.html

Initializes the AssemblerUtils system.

```APIDOC
## init

### Description
Initializes the AssemblerUtils system. This method should be called before using other utility methods.

### Method
`public static void init()`
```

--------------------------------

### HttpOp.httpGet(String)

Source: https://jena.apache.org/documentation/javadoc/arq/index-all.html

Performs an HTTP GET request to the specified URL with an 'Accept' header set to '*/*'.

```APIDOC
## GET httpGet(String url)

### Description
Perform an HTTP GET to a URL, with "Accept" header "*/*".

### Method
GET

### Parameters
- **url** (String) - Required - The target URL for the GET request.
```

--------------------------------

### construct

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/main/runner/Runner.html

Sets up a FusekiServer from the command line options. The returned server has not been started.

```APIDOC
## construct

### Description
Sets up a `FusekiServer` from the command line options. The server is configured but not yet started.

### Method Signature
`FusekiServer construct(String... args)`

### Parameters
#### Path Parameters
- **args** (String...) - The command-line arguments for configuring the Fuseki server.

### Returns
- `FusekiServer` - The constructed, but not yet started, server instance.
```

--------------------------------

### HttpLib.newGetRequest(String, Consumer<HttpRequest.Builder>)

Source: https://jena.apache.org/documentation/javadoc/arq/index-all.html

Creates a new HTTP GET request builder.

```APIDOC
## Method: HttpLib.newGetRequest(String, Consumer<HttpRequest.Builder>)

### Description
Returns a new HttpRequest object configured for a GET request.

### Parameters
- **url** (String) - The target URL.
- **builderConsumer** (Consumer<HttpRequest.Builder>) - A consumer to configure the request builder.
```

--------------------------------

### Get Value

Source: https://jena.apache.org/documentation/javadoc/ontapi/org.apache.jena.ontapi/org/apache/jena/ontapi/impl/objects/OntClassImpl.DataSomeValuesFromImpl.html

Gets the encapsulated data range or class expression.

```APIDOC
## Method: getValue

### Description
Gets an RDF-value (a filler in OWL-API terms) encapsulated by this expression (that can be either `class` or `data range` expression). The result is not `null` even if it is an Unqualified Cardinality Restriction, that has no explicit filler in RDF (the filler is expected to be either `owl:Thing` for object restriction or `RDFS.Literal` for data restriction).

### Returns
`OntDataRange` - The encapsulated value, not `null`.
```

--------------------------------

### Get Factory Instance

Source: https://jena.apache.org/documentation/javadoc/arq/org.apache.jena.arq/org/apache/jena/sparql/function/user/UserDefinedFunctionFactory.html

Gets the singleton static instance of the `UserDefinedFunctionFactory`.

```APIDOC
## getFactory

### Description
Returns the static singleton instance of the `UserDefinedFunctionFactory`.

### Method
`static UserDefinedFunctionFactory getFactory()`

### Response
#### Success Response (UserDefinedFunctionFactory)
- **UserDefinedFunctionFactory** - The singleton factory instance.

### Example
```java
UserDefinedFunctionFactory factory = UserDefinedFunctionFactory.getFactory();
```
```

--------------------------------

### OpVisitorExprPrepare Constructor

Source: https://jena.apache.org/documentation/javadoc/arq/org.apache.jena.arq/org/apache/jena/sparql/algebra/optimize/OpVisitorExprPrepare.html

Initializes a new instance of the OpVisitorExprPrepare class with the specified context.

```APIDOC
## OpVisitorExprPrepare(Context context)

### Description
Constructs a new OpVisitorExprPrepare with the given context.

### Parameters
#### Path Parameters
- **context** (Context) - Required - The context to use for expression preparation.
```

--------------------------------

### execBasic(String... args)

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/main/runner/FusekiRunner.html

Starts a minimal Fuseki server, suitable for embedded use and testing.

```APIDOC
## static void execBasic(String... args)

### Description
Starts a minimal Fuseki server, suitable for embedded use and testing.

### Parameters
- **args** (String...) - Command line arguments for server configuration.
```

--------------------------------

### static get()

Source: https://jena.apache.org/documentation/javadoc/arq/org.apache.jena.arq/org/apache/jena/sparql/engine/QueryEngineRegistry.html

Gets the default global query engine registry.

```APIDOC
## static get()

### Description
Gets the default global query engine registry.

### Method
static QueryEngineRegistry get()
```

--------------------------------

### Example Command Line Invocation

Source: https://jena.apache.org/documentation/tools/schemagen.html

Demonstrates how to invoke the schemagen tool with command line options for input file, ontology processing, and uppercase naming.

```bash
Java jena.schemagen -i myvocab.owl --ontology --uppercase
```

--------------------------------

### runAsyncMain(String... args)

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/main/runner/FusekiRunner.html

Starts a basic Fuseki server with ping, Shiro, and Prometheus support asynchronously.

```APIDOC
## static FusekiServer runAsyncMain(String... args)

### Description
Starts a basic Fuseki server with ping, Shiro, and Prometheus support asynchronously.

### Parameters
- **args** (String...) - Command line arguments for server configuration.

### Returns
- **FusekiServer** - The running server instance.
```

--------------------------------

### RDF/XML Example

Source: https://jena.apache.org/documentation/io/rdf-json.html

An example of RDF data expressed in RDF/XML format.

```rdfxml
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
  xmlns:foaf="http://xmlns.com/foaf/0.1/"
  xmlns:dc="http://purl.org/dc/elements/1.1/">
  <rdf:Description rdf:about="http://example.org/about">
    <dc:creator>Anna Wilder</dc:creator>
    <dc:title xml:lang="en">Anna's Homepage</dc:title>
    <foaf:maker rdf:nodeID="person" />
  </rdf:Description>
  <rdf:Description rdf:nodeID="person">
    <foaf:homepage rdf:resource="http://example.org/about" />
    <foaf:made rdf:resource="http://example.org/about" />
    <foaf:name>Anna Wilder</foaf:name>
    <foaf:firstName>Anna</foaf:firstName>
    <foaf:surname>Wilder</foaf:surname>
    <foaf:depiction rdf:resource="http://example.org/pic.jpg" />
    <foaf:nick>wildling</foaf:nick>
    <foaf:nick>wilda</foaf:nick>
    <foaf:mbox_sha1sum>69e31bbcf58d432950127593e292a55975bc66fd</foaf:mbox_sha1sum>
  </rdf:Description>
</rdf:RDF>
```

--------------------------------

### Transactional.promote()

Source: https://jena.apache.org/documentation/javadoc/arq/index-all.html

Attempts to promote a transaction from read mode to write mode for transactions started with a promote-capable mode.

```APIDOC
## void promote()

### Description
Attempt to promote a transaction from "read" to "write" when the transaction started with a "promote" mode (READ_PROMOTE or READ_COMMITTED_PROMOTE).
```

--------------------------------

### RDFList.indexOf(RDFNode value, int start)

Source: https://jena.apache.org/documentation/javadoc/jena/org.apache.jena.core/org/apache/jena/rdf/model/class-use/RDFNode.html

Answers the index of the first occurrence of the given value in the list after index `start`, or -1 if the value is not in the list after the given start point.

```APIDOC
## RDFList.indexOf(RDFNode value, int start)

### Description
Answer the index of the first occurrence of the given value in the list after index `start`, or -1 if the value is not in the list after the given start point.

### Method
`int`

### Parameters
* **value** (RDFNode) - The node to find the index of.
* **start** (int) - The starting index for the search.

### Return Value
`int` - The index of the first occurrence of the value after `start`, or -1 if not found.
```

--------------------------------

### FusekiServer.run

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/index-all.html

Methods to start a Fuseki server instance.

```APIDOC
### Methods
- `run(int port, String name, DatasetGraph dsg)`
- `run(String... args)`

### Description
Starts a Fuseki server. The `run(int, String, DatasetGraph)` method runs a server for a single dataset, while `run(String...)` runs a server based on command line arguments.
```

--------------------------------

### start()

Source: https://jena.apache.org/documentation/javadoc/text/org.apache.jena.text/org/apache/jena/query/text/TextDocProducerTriples.html

Indicates that a sequence of changes is about to start. This method is part of the TextDatasetChanges interface.

```APIDOC
## start()

### Description
Indicator that a sequence of changes is about to start.

### Method
`void start()`

### Implements
`TextDatasetChanges.start`
```

--------------------------------

### setupSpatialIndex(Dataset dataset, String srsURI, Path spatialIndexFile)

Source: https://jena.apache.org/documentation/javadoc/geosparql/org.apache.jena.geosparql/org/apache/jena/geosparql/configuration/GeoSPARQLConfig.html

Sets up a spatial index using the provided Dataset and a specific SRS URI. The created spatial index is then written to the specified file.

```APIDOC
## setupSpatialIndex(Dataset dataset, String srsURI, Path spatialIndexFile)

### Description
Sets up a spatial index using the provided Dataset and a specific SRS URI. The created spatial index is then written to the specified file.

### Method
`public static final void setupSpatialIndex(org.apache.jena.query.Dataset dataset, String srsURI, Path spatialIndexFile)`

### Parameters
#### Path Parameters
- `dataset` (org.apache.jena.query.Dataset) - The dataset to use for setting up the spatial index.
- `srsURI` (String) - The specific SRS URI to use for the spatial index.
- `spatialIndexFile` (Path) - The file path where the serialized spatial index will be written.

### Throws
- `SpatialIndexException` - If an error occurs during spatial index setup.
```

--------------------------------

### Execute Query with Explanation on Command Line

Source: https://jena.apache.org/documentation/query/explain.html

Run a query with explanation enabled using `arq.query` on the command line. This is equivalent to using `--explain` for query execution logging.

```bash
arq.query --explain --data data file --query=queryfile
```

--------------------------------

### FusekiServer.start()

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/main/class-use/FusekiServer.html

Starts the server instance. The server continues to run after this call returns.

```APIDOC
### FusekiServer.start()

Start the server - the server continues to run after this call returns.
```

--------------------------------

### Canonical Literal Examples

Source: https://jena.apache.org/documentation/javadoc/arq/org.apache.jena.arq/org/apache/jena/riot/RDFParserBuilder.html

Examples of literal pairs where the first is the canonical form.

```text
    "1"^^xsd:integer and "+01"^^xsd:integer
    "1.0E0"^^xsd:double and "1"^^xsd:double
```

--------------------------------

### runAsync

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/main/runner/Runner.html

Sets up a FusekiServer from command-line options and runs it asynchronously. The server is started, and the server object is returned to the caller.

```APIDOC
## runAsync

### Description
Sets up a `FusekiServer` from the command line options and runs it asynchronously.

### Method Signature
`FusekiServer runAsync(String... args)`

### Parameters
#### Path Parameters
- **args** (String...) - The command-line arguments for configuring the Fuseki server.

### Returns
- `FusekiServer` - The running server instance.
```

--------------------------------

### Example of a Retrieved Literal

Source: https://jena.apache.org/documentation/query/text-query.html

An example of a literal that might be bound to ?lit in the previous query.

```sparql
"zorn protégé a prés"@fr

```

--------------------------------

### FusekiServer.start()

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/index-all.html

Starts the server instance, which continues to run after the call returns.

```APIDOC
## Method: start()

### Description
Starts the server. The server continues to run after this call returns.

### Signature
`void start()`
```

--------------------------------

### begin

Source: https://jena.apache.org/documentation/javadoc/arq/org.apache.jena.arq/org/apache/jena/sparql/core/TransactionHandlerView.html

Starts a new transaction.

```APIDOC
## begin

### Description
Starts a new transaction.

### Method
void

### Endpoint
N/A (Method call)

### Parameters
None
```

--------------------------------

### start

Source: https://jena.apache.org/documentation/javadoc/rdfpatch/org.apache.jena.rdfpatch/org/apache/jena/rdfpatch/changes/RDFChangesWrapper.html

Starts processing. This method is part of the RDFChanges interface and indicates the beginning of a sequence of changes.

```APIDOC
## start

### Description
Starts processing. The exact meaning is implementation dependent. This should be paired with a `finish()`.

### Method
`public void start()`

### Interface
`RDFChanges`
```

--------------------------------

### init

Source: https://jena.apache.org/documentation/javadoc/ontapi/org.apache.jena.ontapi/org/apache/jena/ontapi/OntModelFactory.html

Initializes the Jena System.

```APIDOC
## init()

### Description
Initializes Jena System.

### Method
static void

### Endpoint
N/A (Static method)

### Parameters
None

### Response
None (void method).
```

--------------------------------

### Specifying Configuration Root with Command Line and Config File

Source: https://jena.apache.org/documentation/tools/schemagen.html

Example of how to specify the configuration root URI on the command line, which must match the URI in the configuration file.

```Java
Java jena.schemagen -c config/localconf.rdf -r http://example.org/sg#project1

```

```xml
<sgen:Config rdf:about="http://example.org/SG#project1">
   ....
 </sgen:Config>

```

--------------------------------

### logServerStarted

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/main/runner/FusekiRunnerLogging.html

Logs that the server has started. This method is called to indicate that the Fuseki server has successfully started.

```APIDOC
## logServerStarted

### Description

Logs that the server has started. This method is called to indicate that the Fuseki server has successfully started.

### Method Signature

`public static void logServerStarted(org.slf4j.Logger log, FusekiServer server)`

### Parameters

* **log** (org.slf4j.Logger) - The logger instance to use for logging.
* **server** (FusekiServer) - The FusekiServer instance that has started.
```

--------------------------------

### setup(IndexConfiguration.IndexOption indexOption)

Source: https://jena.apache.org/documentation/javadoc/geosparql/org.apache.jena.geosparql/org/apache/jena/geosparql/configuration/GeoSPARQLConfig.html

Initializes all GeoSPARQL property and filter functions with query rewrite enabled. This method configures the indexing based on the provided IndexOption and does not affect Spatial Indexes for Datasets.

```APIDOC
## setup(IndexConfiguration.IndexOption indexOption)

### Description
Initialise all GeoSPARQL property and filter functions. Query rewrite enabled.
This does not affect the use of Spatial Indexes for Datasets.

### Method
public static final void setup(IndexConfiguration.IndexOption indexOption)

### Endpoint
N/A (Static method)

### Parameters
#### Query Parameters
- **indexOption** (IndexConfiguration.IndexOption) - Required - The indexing option to use.
```

--------------------------------

### Assemble Text Dataset in Java

Source: https://jena.apache.org/documentation/query/text-query.html

Demonstrates how to assemble a text dataset configuration in Java code, specifying the configuration file and the text dataset URI.

```Java
Dataset ds = DatasetFactory.assemble(
    "text-config.ttl", 
    "http://localhost/jena_example/#text_dataset") ;


```

--------------------------------

### static get(Context context)

Source: https://jena.apache.org/documentation/javadoc/arq/org.apache.jena.arq/org/apache/jena/sparql/engine/QueryEngineRegistry.html

Gets the query engine registry from the context, or null if there is none.

```APIDOC
## static get(Context context)

### Description
Gets the query engine registry from the context, or null if there is none.

### Method
static QueryEngineRegistry get(Context context)

### Parameters
#### Path Parameters
- **context** (Context) - The context to retrieve the registry from.
```

--------------------------------

### Async GET to StreamRDF

Source: https://jena.apache.org/documentation/javadoc/arq/org.apache.jena.arq/org/apache/jena/http/AsyncHttpRDF.html

Execute an asynchronous GET request and parse the result directly to a StreamRDF.

```APIDOC
## asyncGetToStream

### Description
Execute an asynchronous GET and parse the result to a StreamRDF. If "transactional" is not null, the object is used as a write transaction around the parsing step. Call `CompletableFuture.join()` to await completion. Call `syncOrElseThrow(CompletableFuture)` to await completion, with exceptions translated to the underlying `RuntimeException`.

### Method Signature
`public static CompletableFuture<Void> asyncGetToStream(HttpClient httpClient, String url, String acceptHeader, StreamRDF dest, Transactional transactional)`

### Parameters
* **httpClient** (HttpClient) - The HTTP client to use for the request.
* **url** (String) - The URL to fetch data from.
* **acceptHeader** (String) - The Accept header value for the request.
* **dest** (StreamRDF) - The destination to stream the parsed RDF data to.
* **transactional** (Transactional) - An optional transactional object to wrap the parsing.
```

--------------------------------

### Document Manager Specification Example

Source: https://jena.apache.org/documentation/assembler/assembler-howto.html

This example shows how to specify a Document Manager with a FileManager and meta-data.

```N3
eg:mapper
    lm:mapping [lm:altName "file:etc/foo.n3" ;
    lm:name "file:foo.n3"]
    .
eg:document-manager-example
    ja:fileManager [ja:locationMapper eg:mapper] ;
    ja:meta [ dm:altURL <http://localhost/RDF/my-alt.rdf>]
    .

```

--------------------------------

### Get and Set Value for Ontology Object

Source: https://jena.apache.org/documentation/javadoc/ontapi/org.apache.jena.ontapi/org/apache/jena/ontapi/impl/objects/OntClassImpl.NaryRestrictionImpl.html

Provides methods to get and set the value of an ontology object.

```java
public O getValue()
```

```java
public R setValue(O value)
```

--------------------------------

### PrintUtil.init()

Source: https://jena.apache.org/documentation/javadoc/jena/index-all.html

Loads built-in prefixes for utility printing.

```APIDOC
## Method: init()

### Description
Load built-in prefixes for the PrintUtil utility.

### Signature
static void init()
```

--------------------------------

### JSON Query Syntax Example

Source: https://jena.apache.org/documentation/query/generate-json-from-sparql.html

This example demonstrates the JSON query syntax, which is similar to SPARQL CONSTRUCT.

```sparql
PREFIX purl: <http://purl.org/dc/elements/1.1/>
PREFIX w3: <http://www.w3.org/2001/vcard-rdf/3.0/>
PREFIX : <http://example.org/book/> 

JSON {
  "author": ?author, 
  "title": ?title 
}
WHERE 
{
  ?book purl:creator ?author .
  ?book purl:title ?title .
  FILTER (?author = 'J.K. Rowling')
}

```

--------------------------------

### setupSpatialIndex(Dataset dataset, Path spatialIndexFile)

Source: https://jena.apache.org/documentation/javadoc/geosparql/org.apache.jena.geosparql/org/apache/jena/geosparql/configuration/GeoSPARQLConfig.html

Sets up a spatial index using the provided Dataset and the most frequent SRS URI found within it. The created spatial index is then written to the specified file.

```APIDOC
## setupSpatialIndex(Dataset dataset, Path spatialIndexFile)

### Description
Sets up a spatial index using the provided Dataset and the most frequent SRS URI found within it. The created spatial index is then written to the specified file.

### Method
`public static final void setupSpatialIndex(org.apache.jena.query.Dataset dataset, Path spatialIndexFile)`

### Parameters
#### Path Parameters
- `dataset` (org.apache.jena.query.Dataset) - The dataset to use for setting up the spatial index.
- `spatialIndexFile` (Path) - The file path where the serialized spatial index will be written.

### Throws
- `SpatialIndexException` - If an error occurs during spatial index setup.
```

--------------------------------

### Custom JSON Output Example

Source: https://jena.apache.org/documentation/query/generate-json-from-sparql.html

This is an example of the custom JSON output format generated by the Jena extension.

```json
[
  {
    "book": "http://example.org/book/book6",
    "title": "Harry Potter and the Half-Blood Prince"
  },
  {
    "book": "http://example.org/book/book7",
    "title": "Harry Potter and the Deathly Hallows"
  },
]

```

--------------------------------

### FusekiServer construct(String... args)

Source: https://jena.apache.org/documentation/javadoc/fuseki2-main/org.apache.jena.fuseki.main/org/apache/jena/fuseki/main/FusekiMain.html

Builds a Fuseki server instance based on command-line syntax but does not start it. This is useful for further configuration before execution.

```APIDOC
## construct(String... args)

### Description
Build, but do not start, a server based on command line syntax.

### Method
`public static FusekiServer construct(String... args)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
FusekiServer server = FusekiMain.construct("--port=0");
// Further configuration can be done on the server object before starting it.
```

### Response
#### Success Response (200)
`FusekiServer` - A configured but not yet started Fuseki server instance.
```

--------------------------------

### SSE Query 1 Example

Source: https://jena.apache.org/documentation/notes/sse.html

A longer example demonstrating a SPARQL query expressed in SSE format.

```text
(prefix ((: <http://example.org/>))
  (select (?x) 
    (where 
      (bgp 
        (triple ?x :type :Person)
        (triple ?x :name "Alice")
      )
    )
  )
)

```
Tokens:
Raw