com.hp.hpl.jena.util

Class FileManager

java.lang.Object

com.hp.hpl.jena.util.FileManager

public class FileManager
extends Object

FileManager A FileManager provides access to named file-like resources by opening InputStreams to things in the filing system, by URL (http: and file:) and found by the classloader. It can also load RDF data from such a system resource into an existing model or create a new (Memory-based) model. There is a global FileManager which provide uniform access to system resources: applications may also create specialised FileManagers. A FileManager contains a list of location functions to try: the global FileManger has one LocatorFile, one LocatorClassLoader and one LocatorURL Main operations: *

• loadModel, readModel : URI to model
• open, openNoMap : URI to input stream
• mapURI : map URI to another by LocationMapper

Utilities:

• readWholeFileAsUTF8
• optional caching of models

A FileManager works in conjunction with a LocationMapper. A LocationMapper is a set of alternative locations for system resources and a set of alternative prefix locations. For example, a local copy of a common RDF dataset may be used whenever the usual URL is used by the application. The LocatorFile also supports the idea of "current directory".

See Also:

LocationMapper, FileUtils

Field Summary

Fields

Modifier and Type	Field and Description
static String	filePathSeparator
static String	PATH_DELIMITER Delimiter between path entries : because URI scheme names use : we only allow ;

Constructor Summary

Constructors

Constructor and Description
FileManager() Create an uninitialized FileManager
FileManager(FileManager filemanager) Deprecated. Call filemanager.clone() to get a duplicate FileManager.
FileManager(LocationMapper _mapper) Create with the given location mapper

Method Summary

Methods

Modifier and Type	Method and Description
void	addCacheModel(String uri, Model m)
void	addLocator(Locator loc) Add a locator to the end of the locators list
void	addLocatorClassLoader(ClassLoader cLoad) Add a class loader locator
void	addLocatorFile() Add a file locator
void	addLocatorFile(String dir) Add a file locator which uses dir as its working directory
void	addLocatorURL() Add a URL locator
void	addLocatorZip(String zfn) Add a zip file locator
FileManager	clone()
static FileManager	get() Get the global file manager.
boolean	getCachingModels() Deprecated. Use isCachingModels()
Model	getFromCache(String filenameOrURI) Read out of the cache - return null if not in the cache
LocationMapper	getLocationMapper() Get the location mapping
boolean	hasCachedModel(String filenameOrURI)
boolean	isCachingModels() return whether caching is on of off
Model	loadModel(String filenameOrURI) Load a model from a file (local or remote).
Model	loadModel(String filenameOrURI, String rdfSyntax) Load a model from a file (local or remote).
Model	loadModel(String filenameOrURI, String baseURI, String rdfSyntax) Load a model from a file (local or remote).
Iterator<Locator>	locators() Return an iterator over all the handlers
static FileManager	makeGlobal() Create a "standard" FileManager.
String	mapURI(String filenameOrURI) Apply the mapping of a filename or URI
InputStream	open(String filenameOrURI) Open a file using the locators of this FileManager
InputStream	openNoMap(String filenameOrURI) Open a file using the locators of this FileManager but without location mapping
TypedStream	openNoMapOrNull(String filenameOrURI) Open a file using the locators of this FileManager but without location mapping.
Model	readModel(Model model, String filenameOrURI) Read a file of RDF into a model.
Model	readModel(Model model, String filenameOrURI, String rdfSyntax) Read a file of RDF into a model.
Model	readModel(Model model, String filenameOrURI, String baseURI, String syntax) Read a file of RDF into a model.
String	readWholeFileAsUTF8(InputStream in) Slurp up a whole file
String	readWholeFileAsUTF8(String filename) Slurp up a whole file: map filename as necessary
String	remap(String filenameOrURI) Deprecated. Use mapURI
void	remove(Locator loc) Remove a locator
void	removeCacheModel(String uri)
void	resetCache() Reset the model cache
static void	setGlobalFileManager(FileManager globalFileManager) Set the global file manager (as returned by get()) If called before any call to get(), then the usual default filemanager is not created
void	setLocationMapper(LocationMapper _mapper) Set the location mapping
void	setMapper(LocationMapper _mapper) Deprecated. Use setLocationMapper
void	setModelCaching(boolean state) Change the state of model cache : does not clear the cache
static void	setStdLocators(FileManager fMgr) Force a file handler to have the default configuration.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_DELIMITER

public static final String PATH_DELIMITER

Delimiter between path entries : because URI scheme names use : we only allow ;

See Also:

Constant Field Values

filePathSeparator

public static final String filePathSeparator

Constructor Detail

FileManager

public FileManager()

Create an uninitialized FileManager

FileManager

@Deprecated
public FileManager(FileManager filemanager)

Deprecated. Call filemanager.clone() to get a duplicate FileManager.

Create a new file manager that is a deep copy another. Location mapper and locators chain are copied (the locators are not cloned). The model cache is not copied and is initially set to not cache.

Parameters:

filemanager -

FileManager

public FileManager(LocationMapper _mapper)

Create with the given location mapper

Method Detail

get

public static FileManager get()

Get the global file manager.

Returns:

the global file manager

setGlobalFileManager

public static void setGlobalFileManager(FileManager globalFileManager)

Set the global file manager (as returned by get()) If called before any call to get(), then the usual default filemanager is not created

Parameters:

globalFileManager -

clone

public FileManager clone()

Overrides:

clone in class Object

makeGlobal

public static FileManager makeGlobal()

Create a "standard" FileManager.

setStdLocators

public static void setStdLocators(FileManager fMgr)

Force a file handler to have the default configuration.

setMapper

@Deprecated
public void setMapper(LocationMapper _mapper)

Deprecated. Use setLocationMapper

setLocationMapper

public void setLocationMapper(LocationMapper _mapper)

Set the location mapping

getLocationMapper

public LocationMapper getLocationMapper()

Get the location mapping

locators

public Iterator<Locator> locators()

Return an iterator over all the handlers

addLocator

public void addLocator(Locator loc)

Add a locator to the end of the locators list

addLocatorFile

public void addLocatorFile()

Add a file locator

addLocatorFile

public void addLocatorFile(String dir)

Add a file locator which uses dir as its working directory

addLocatorClassLoader

public void addLocatorClassLoader(ClassLoader cLoad)

Add a class loader locator

addLocatorURL

public void addLocatorURL()

Add a URL locator

addLocatorZip

public void addLocatorZip(String zfn)

Add a zip file locator

remove

public void remove(Locator loc)

Remove a locator

resetCache

public void resetCache()

Reset the model cache

setModelCaching

public void setModelCaching(boolean state)

Change the state of model cache : does not clear the cache

getCachingModels

@Deprecated
public boolean getCachingModels()

Deprecated. Use isCachingModels()

isCachingModels

public boolean isCachingModels()

return whether caching is on of off

getFromCache

public Model getFromCache(String filenameOrURI)

Read out of the cache - return null if not in the cache

hasCachedModel

public boolean hasCachedModel(String filenameOrURI)

addCacheModel

public void addCacheModel(String uri,
                 Model m)

removeCacheModel

public void removeCacheModel(String uri)

loadModel

public Model loadModel(String filenameOrURI)

Load a model from a file (local or remote). Guesses the syntax of the file based on filename extension, defaulting to RDF/XML.

Parameters:

filenameOrURI - The filename or a URI (file:, http:)

Returns:

a new model

Throws:

JenaException - if there is syntax error in file.

loadModel

public Model loadModel(String filenameOrURI,
              String rdfSyntax)

Load a model from a file (local or remote). URI is the base for reading the model.

Parameters:

filenameOrURI - The filename or a URI (file:, http:)

rdfSyntax - RDF Serialization syntax.

Returns:

a new model

Throws:

JenaException - if there is syntax error in file.

loadModel

public Model loadModel(String filenameOrURI,
              String baseURI,
              String rdfSyntax)

Load a model from a file (local or remote).

Parameters:

filenameOrURI - The filename or a URI (file:, http:)

baseURI - Base URI for loading the RDF model.

rdfSyntax - RDF Serialization syntax.

Returns:

a new model

Throws:

JenaException - if there is syntax error in file.

readModel

public Model readModel(Model model,
              String filenameOrURI)

Read a file of RDF into a model. Guesses the syntax of the file based on filename extension, defaulting to RDF/XML.

Parameters:

model -

filenameOrURI -

Returns:

The model or null, if there was an error.

Throws:

JenaException - if there is syntax error in file.

readModel

public Model readModel(Model model,
              String filenameOrURI,
              String rdfSyntax)

Read a file of RDF into a model.

Parameters:

model -

filenameOrURI -

rdfSyntax - RDF Serialization syntax.

Returns:

The model or null, if there was an error.

Throws:

JenaException - if there is syntax error in file.

readModel

public Model readModel(Model model,
              String filenameOrURI,
              String baseURI,
              String syntax)

Read a file of RDF into a model.

Parameters:

model -

filenameOrURI -

baseURI -

syntax -

Returns:

The model

Throws:

JenaException - if there is syntax error in file.

open

public InputStream open(String filenameOrURI)

Open a file using the locators of this FileManager

remap

@Deprecated
public String remap(String filenameOrURI)

Deprecated. Use mapURI

mapURI

public String mapURI(String filenameOrURI)

Apply the mapping of a filename or URI

readWholeFileAsUTF8

public String readWholeFileAsUTF8(InputStream in)

Slurp up a whole file

readWholeFileAsUTF8

public String readWholeFileAsUTF8(String filename)

Slurp up a whole file: map filename as necessary

openNoMap

public InputStream openNoMap(String filenameOrURI)

Open a file using the locators of this FileManager but without location mapping

openNoMapOrNull

public TypedStream openNoMapOrNull(String filenameOrURI)

Open a file using the locators of this FileManager but without location mapping. Return null if not found