net.exogeni.orca.ndl

Class NdlModel

java.lang.Object

net.exogeni.orca.ndl.NdlModel

public class NdlModel
extends java.lang.Object

Class that encapsulates NDL Model handling

Author:

ibaldin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NdlModel.LocatorJarURL Jena does not handle java jar:file: URLs, so we need this locator
static class	NdlModel.ModelType

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,java.lang.String>	externalSchemas
static java.lang.String[]	orcaSchemaFiles
static java.lang.String[]	orcaSubstrateFiles

Constructor Summary

Constructors

Constructor and Description
NdlModel()

Method Summary

Modifier and Type	Method and Description
static void	closeModel(com.hp.hpl.jena.ontology.OntModel m) Close model and remove its disk space
static com.hp.hpl.jena.ontology.OntModel	createModel(com.hp.hpl.jena.ontology.OntModelSpec spec, boolean uniqueDM) Create a blank in-memory model
static com.hp.hpl.jena.ontology.OntModel	createModel(com.hp.hpl.jena.ontology.OntModelSpec spec, boolean uniqueDM, NdlModel.ModelType t, java.lang.String folderName) Create a blank model
static com.hp.hpl.jena.ontology.OntModel	getModelFromFile(java.lang.String aFile, com.hp.hpl.jena.ontology.OntModelSpec spec, boolean uniqueDM) Get an in-memory model from file.
static com.hp.hpl.jena.ontology.OntModel	getModelFromFile(java.lang.String aFile, com.hp.hpl.jena.ontology.OntModelSpec spec, boolean uniqueDM, NdlModel.ModelType t, java.lang.String folderName) Get a model from file.
static com.hp.hpl.jena.ontology.OntModel	getModelFromStream(java.io.InputStream modelStream, com.hp.hpl.jena.ontology.OntModelSpec spec, boolean uniqueDM) Get an in-memory model from specified stream
static com.hp.hpl.jena.ontology.OntModel	getModelFromStream(java.io.InputStream modelStream, com.hp.hpl.jena.ontology.OntModelSpec spec, boolean uniqueDM, NdlModel.ModelType t, java.lang.String folderName) Create a new model.
static com.hp.hpl.jena.ontology.OntModel	getModelFromString(java.lang.String s, com.hp.hpl.jena.ontology.OntModelSpec spec, boolean uniqueDM) Initialize and return an in-memory model from RDF/XML String.
static com.hp.hpl.jena.ontology.OntModel	getModelFromString(java.lang.String s, com.hp.hpl.jena.ontology.OntModelSpec spec, boolean uniqueDM, NdlModel.ModelType t, java.lang.String folderName) Initialize and return a model from RDF/XML String.
static com.hp.hpl.jena.ontology.OntModel	getModelFromTDB(java.lang.String d, com.hp.hpl.jena.ontology.OntModelSpec s) Create a TDB backed model from pre-existing store
static com.hp.hpl.jena.ontology.OntModelSpec	getOntModelSpec(com.hp.hpl.jena.ontology.OntModelSpec spec, boolean uniqueDM)
static com.hp.hpl.jena.ontology.OntModel	getRequestModelFromStream(java.io.InputStream modelStream, com.hp.hpl.jena.ontology.OntModelSpec spec, boolean uniqueDM) Create an in-memory request model.
static com.hp.hpl.jena.ontology.OntModel	getRequestModelFromStream(java.io.InputStream modelStream, com.hp.hpl.jena.ontology.OntModelSpec spec, boolean uniqueDM, NdlModel.ModelType t, java.lang.String folderName) Create a request model.
static void	setGlobalJenaRedirections()
static void	setJenaRedirections(com.hp.hpl.jena.ontology.OntDocumentManager dm) Set common redirections for a specific document manager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

orcaSchemaFiles

public static final java.lang.String[] orcaSchemaFiles

orcaSubstrateFiles

public static final java.lang.String[] orcaSubstrateFiles

externalSchemas

public static final java.util.Map<java.lang.String,java.lang.String> externalSchemas

Constructor Detail

NdlModel

public NdlModel()

Method Detail

setJenaRedirections

public static void setJenaRedirections(com.hp.hpl.jena.ontology.OntDocumentManager dm)

Set common redirections for a specific document manager

Parameters:

dm - dm

closeModel

public static void closeModel(com.hp.hpl.jena.ontology.OntModel m)

Close model and remove its disk space

Parameters:

m - m

getOntModelSpec

public static com.hp.hpl.jena.ontology.OntModelSpec getOntModelSpec(com.hp.hpl.jena.ontology.OntModelSpec spec,
                                                                    boolean uniqueDM)

getModelFromStream

public static com.hp.hpl.jena.ontology.OntModel getModelFromStream(java.io.InputStream modelStream,
                                                                   com.hp.hpl.jena.ontology.OntModelSpec spec,
                                                                   boolean uniqueDM,
                                                                   NdlModel.ModelType t,
                                                                   java.lang.String folderName)
                                                            throws NdlException

Create a new model. If spec is null, OntModelSpec.OWL_MEM - simple in-memory model will be built. For inference use OntModelSpec.RDFS_MEM_TRANS_INF. Optionally create a model with a new DocumentManager.

Parameters:

modelStream - modelStream

spec - spec

uniqueDM - - unique document manager (usually yes)

t - - in-memory, TDB ephemeral or persistent

folderName - - optionally, the name of the folder where to save TDB (temprorary will be created if null)

Returns:

OntModel

Throws:

NdlException - in case of error

getModelFromStream

public static com.hp.hpl.jena.ontology.OntModel getModelFromStream(java.io.InputStream modelStream,
                                                                   com.hp.hpl.jena.ontology.OntModelSpec spec,
                                                                   boolean uniqueDM)
                                                            throws NdlException

Get an in-memory model from specified stream

Parameters:

modelStream - modelStream

spec - - model spec

uniqueDM - - create a unique document manager (usually yes)

Returns:

OntModel

Throws:

NdlException - in case of error

getModelFromFile

public static com.hp.hpl.jena.ontology.OntModel getModelFromFile(java.lang.String aFile,
                                                                 com.hp.hpl.jena.ontology.OntModelSpec spec,
                                                                 boolean uniqueDM)
                                                          throws NdlException

Get an in-memory model from file. If spec is null, OntModelSpec.OWL_MEM - simple in memory model will be built. For inference use OntModelSpec.RDFS_MEM_TRANS_INF. Optionally create a model with a new DocumentManager.

Parameters:

aFile - aFile

spec - spec

uniqueDM - uniqueDM

Returns:

OntModel

Throws:

NdlException - in case of error

getModelFromFile

public static com.hp.hpl.jena.ontology.OntModel getModelFromFile(java.lang.String aFile,
                                                                 com.hp.hpl.jena.ontology.OntModelSpec spec,
                                                                 boolean uniqueDM,
                                                                 NdlModel.ModelType t,
                                                                 java.lang.String folderName)
                                                          throws NdlException

Get a model from file. If spec is null, OntModelSpec.OWL_MEM - simple in memory model will be built. For inference use OntModelSpec.RDFS_MEM_TRANS_INF. Optionally create a model with a new DocumentManager.

Parameters:

aFile - aFile

spec - spec

uniqueDM - uniqueDM

t - - in-memory, TDB persistent or ephemeral

folderName - - for TDB

Returns:

OntModel

Throws:

NdlException - in case of error

getRequestModelFromStream

public static com.hp.hpl.jena.ontology.OntModel getRequestModelFromStream(java.io.InputStream modelStream,
                                                                          com.hp.hpl.jena.ontology.OntModelSpec spec,
                                                                          boolean uniqueDM,
                                                                          NdlModel.ModelType t,
                                                                          java.lang.String folderName)
                                                                   throws NdlException

Create a request model. If spec is null, OntModelSpec.OWL_MEM - simple in memory model will be built. For inference use OntModelSpec.RDFS_MEM_TRANS_INF. Optionally create a model with a new DocumentManager. If TDB is indicated, folder name can be specified (this will make the model non-ephemeral - persistent across shutdowns)

Parameters:

modelStream - modelStream

spec - spec

uniqueDM - uniqueDM - need a unique DocumentManager (usually yes)

t - - in-memory, TDB ephemeral or persistent

folderName - - optional name of the folder for TDB

Returns:

OntModel

Throws:

NdlException - in case of error

getRequestModelFromStream

public static com.hp.hpl.jena.ontology.OntModel getRequestModelFromStream(java.io.InputStream modelStream,
                                                                          com.hp.hpl.jena.ontology.OntModelSpec spec,
                                                                          boolean uniqueDM)
                                                                   throws NdlException

Create an in-memory request model. If spec is null, OntModelSpec.OWL_MEM - simple in memory model will be built. For inference use OntModelSpec.RDFS_MEM_TRANS_INF. Optionally create a model with a new DocumentManager.

Parameters:

modelStream - modelStream

spec - spec

uniqueDM - uniqueDM

Returns:

OntModel

Throws:

NdlException - in case of error

createModel

public static com.hp.hpl.jena.ontology.OntModel createModel(com.hp.hpl.jena.ontology.OntModelSpec spec,
                                                            boolean uniqueDM,
                                                            NdlModel.ModelType t,
                                                            java.lang.String folderName)
                                                     throws NdlException

Create a blank model

Parameters:

spec - spec

uniqueDM - uniqueDM - with unique document manager

t - - in-memory, TDB persistent or ephemeral

folderName - - optionally (null permitted) specify the name of the folder to store the model

Returns:

OntModel

Throws:

NdlException - in case of error

createModel

public static com.hp.hpl.jena.ontology.OntModel createModel(com.hp.hpl.jena.ontology.OntModelSpec spec,
                                                            boolean uniqueDM)
                                                     throws NdlException

Create a blank in-memory model

Parameters:

spec - spec

uniqueDM - uniqueDM

Returns:

OntModel

Throws:

NdlException - in case of error

getModelFromString

public static com.hp.hpl.jena.ontology.OntModel getModelFromString(java.lang.String s,
                                                                   com.hp.hpl.jena.ontology.OntModelSpec spec,
                                                                   boolean uniqueDM)
                                                            throws NdlException

Initialize and return an in-memory model from RDF/XML String. If spec is null, OntModelSpec.OWL_MEM - simple in memory model will be built. For inference use OntModelSpec.RDFS_MEM_TRANS_INF. Optionally create a model with a new DocumentManager.

Parameters:

s - s

spec - spec

uniqueDM - uniqueDM - use a unique DM

Returns:

OntModel

Throws:

NdlException - in case of error

getModelFromString

public static com.hp.hpl.jena.ontology.OntModel getModelFromString(java.lang.String s,
                                                                   com.hp.hpl.jena.ontology.OntModelSpec spec,
                                                                   boolean uniqueDM,
                                                                   NdlModel.ModelType t,
                                                                   java.lang.String folderName)
                                                            throws NdlException

Initialize and return a model from RDF/XML String. If spec is null, OntModelSpec.OWL_MEM - simple in memory model will be built. For inference use OntModelSpec.RDFS_MEM_TRANS_INF. Optionally create a model with a new DocumentManager.

Parameters:

s - s

spec - spec

uniqueDM - - use a unique DM

t - ModelType (in-memory, tdb ephemeral or persistent)

folderName - for tdb models

Returns:

OntModel

Throws:

NdlException - in case of error

getModelFromTDB

public static com.hp.hpl.jena.ontology.OntModel getModelFromTDB(java.lang.String d,
                                                                com.hp.hpl.jena.ontology.OntModelSpec s)
                                                         throws NdlException

Create a TDB backed model from pre-existing store

Parameters:

d - - directory where TDB store is

s - - OntModelSpec for the model

Returns:

OntModel

Throws:

NdlException - in case of error

setGlobalJenaRedirections

public static void setGlobalJenaRedirections()