edu.stanford.smi.protegex.owl.repository.impl
Class AbstractLocalRepository

java.lang.Object
  edu.stanford.smi.protegex.owl.repository.impl.AbstractLocalRepository

All Implemented Interfaces:

Repository

Direct Known Subclasses:

LocalFileRepository, LocalFolderRepository

public abstract class AbstractLocalRepository

extends Object

implements Repository

User: matthewhorridge
The University Of Manchester
Medical Informatics Group
Date: Sep 21, 2005

matthew.horridge@cs.man.ac.uk
www.cs.man.ac.uk/~horridgm

Field Summary

private File	file
private boolean	forceReadOnly
private Map	ontologies

Constructor Summary

AbstractLocalRepository(File file, boolean forceReadOnly)

Method Summary

boolean	contains(URI ontologyName) Determines if the repository contains the specified ontology.
protected File	getFile()
InputStream	getInputStream(URI ontologyName) Gets an inputstream to read the specified ontology from
Collection	getOntologies() Gets the name of the ontologies that this repository contains.
String	getOntologyLocationDescription(URI ontologyName) Gets a description of where the specified ontology is located.
OutputStream	getOutputStream(URI ontologyName) Gets an output stream which can be used to write changes to the specified ontology.
String	getRepositoryDescriptor() Gets the descriptor for this repository.
boolean	isForceReadOnly()
boolean	isSystem() Determines if the ontology repository is a system repository.
boolean	isWritable(URI ontologyName) Determines if the specified ontology is writable.
protected URI	processFile(File file)
protected void	putOntology(URI ontologyName, File file)
void	refresh() Causes the repository to contain the latest information.
void	setForceReadOnly(boolean forceReadOnly)

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.stanford.smi.protegex.owl.repository.Repository

getRepositoryDescription

Field Detail

file

private File file

forceReadOnly

private boolean forceReadOnly

ontologies

private Map ontologies

Constructor Detail

AbstractLocalRepository

public AbstractLocalRepository(File file,
                               boolean forceReadOnly)

Method Detail

getFile

protected File getFile()

refresh

public void refresh()

Description copied from interface: Repository

Causes the repository to contain the latest information.

Specified by:

refresh in interface Repository

putOntology

protected void putOntology(URI ontologyName,
                           File file)

contains

public boolean contains(URI ontologyName)

Description copied from interface: Repository

Determines if the repository contains the specified ontology.

Specified by:

contains in interface Repository

Parameters:

ontologyName - The name of the ontology.

getOntologies

public Collection getOntologies()

Description copied from interface: Repository

Gets the name of the ontologies that this repository contains.

Specified by:

getOntologies in interface Repository

Returns:

A Collection containing URIs.

getInputStream

public InputStream getInputStream(URI ontologyName)
                           throws IOException

Description copied from interface: Repository

Gets an inputstream to read the specified ontology from

Specified by:

getInputStream in interface Repository

Parameters:

ontologyName - The name of the ontology.

Returns:

an InputStream to read the ontology from, or null if the repository does not contain the ontology or the ontology cannot be retrieved.

Throws:

IOException

getOutputStream

public OutputStream getOutputStream(URI ontologyName)
                             throws IOException

Description copied from interface: Repository

Gets an output stream which can be used to write changes to the specified ontology.

Specified by:

getOutputStream in interface Repository

Parameters:

ontologyName - The ontology to be written

Returns:

an OutputStream that can be used to write changes to the ontology, or null if the ontology is not writable.

Throws:

IOException

isSystem

public boolean isSystem()

Description copied from interface: Repository

Determines if the ontology repository is a system repository.

Specified by:

isSystem in interface Repository

getOntologyLocationDescription

public String getOntologyLocationDescription(URI ontologyName)

Description copied from interface: Repository

Gets a description of where the specified ontology is located.

Specified by:

getOntologyLocationDescription in interface Repository

Parameters:

ontologyName - The name of the ontology.

Returns:

A String description of the location of the ontology, for example, "file:/Users/Blah/Blah/Blah". This return value will be an empty String if the repository does not contain the specified ontology.

getRepositoryDescriptor

public String getRepositoryDescriptor()

Description copied from interface: Repository

Gets the descriptor for this repository. This is used to serialise the repository in a list of the available repositories.

Specified by:

getRepositoryDescriptor in interface Repository

isWritable

public boolean isWritable(URI ontologyName)

Description copied from interface: Repository

Determines if the specified ontology is writable.

Specified by:

isWritable in interface Repository

Parameters:

ontologyName -

Returns:

true if the ontology is writable, or false if the ontology is not writable.

isForceReadOnly

public boolean isForceReadOnly()

setForceReadOnly

public void setForceReadOnly(boolean forceReadOnly)

processFile

protected URI processFile(File file)