org.semanticweb.owlapi.model

Class OWLOntologyFormat

java.lang.Object

org.semanticweb.owlapi.model.OWLOntologyFormat

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DLSyntaxHTMLOntologyFormat, DLSyntaxOntologyFormat, KRSS2OntologyFormat, KRSSOntologyFormat, LatexAxiomsListOntologyFormat, LatexOntologyFormat, OBOOntologyFormat, PrefixOWLOntologyFormat

public abstract class OWLOntologyFormat
extends Object
implements Serializable

Represents the concrete representation format of an ontology. The equality of an ontology format is defined by the equals and hashCode method (not its identity).

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group, Date: 02-Jan-2007

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	USE_INTERMEDIATE_OUTPUT_FILE if set to "true", an intermediate file will be used for output, even for remote URIs.

Constructor Summary

Constructors

Constructor and Description
OWLOntologyFormat()

Method Summary

Methods

Modifier and Type	Method and Description
PrefixOWLOntologyFormat	asPrefixOWLOntologyFormat() If this format is an instance of PrefixOWLOntologyFormat then this method will obtain it as a PrefixOWLOntologyFormat.
boolean	equals(Object obj)
OWLOntologyLoaderMetaData	getOntologyLoaderMetaData() If this format describes an ontology that was loaded from some ontology document (rather than created programmatically) there may be some meta data about the loading process.
Object	getParameter(Object key, Object defaultValue)
int	hashCode()
boolean	isPrefixOWLOntologyFormat() Determines if this format is an instance of a format that uses prefixes to shorted IRIs.
void	setOntologyLoaderMetaData(OWLOntologyLoaderMetaData loaderMetaData) Sets the meta data for the ontology loader.
void	setParameter(Object key, Object value)

Methods inherited from class java.lang.Object

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

Field Detail

USE_INTERMEDIATE_OUTPUT_FILE

public static String USE_INTERMEDIATE_OUTPUT_FILE

if set to "true", an intermediate file will be used for output, even for remote URIs.

Constructor Detail

OWLOntologyFormat

public OWLOntologyFormat()

Method Detail

setParameter

public void setParameter(Object key,
                Object value)

Parameters:

key - key for the new entry

value - value for the new entry

getParameter

public Object getParameter(Object key,
                  Object defaultValue)

Parameters:

key - key for the new entry

defaultValue - value for the new entry

Returns:

the value

isPrefixOWLOntologyFormat

public boolean isPrefixOWLOntologyFormat()

Determines if this format is an instance of a format that uses prefixes to shorted IRIs.

Returns:

true if this format is an instance of PrefixOWLOntologyFormat other wise false.

asPrefixOWLOntologyFormat

public PrefixOWLOntologyFormat asPrefixOWLOntologyFormat()

If this format is an instance of PrefixOWLOntologyFormat then this method will obtain it as a PrefixOWLOntologyFormat.

Returns:

This format as a more specific PrefixOWLOntologyFormat.

Throws:

ClassCastException - if this format is not an instance of PrefixOWLOntologyFormat

getOntologyLoaderMetaData

public OWLOntologyLoaderMetaData getOntologyLoaderMetaData()

If this format describes an ontology that was loaded from some ontology document (rather than created programmatically) there may be some meta data about the loading process. Subclasses of OWLOntologyFormat will provide accessors etc. to details pertaining to the meta data about loading.

Returns:

An object containing the meta data about loading. Not null.

setOntologyLoaderMetaData

public void setOntologyLoaderMetaData(OWLOntologyLoaderMetaData loaderMetaData)

Sets the meta data for the ontology loader.

Parameters:

loaderMetaData - The metadata. Must not be null.

Throws:

NullPointerException - if the loaderMetaData is null.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object