org.obolibrary.obo2owl

Class OWLAPIOwl2Obo

java.lang.Object

org.obolibrary.obo2owl.OWLAPIOwl2Obo

public class OWLAPIOwl2Obo
extends Object

The Class OWLAPIOwl2Obo.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OWLAPIOwl2Obo.UntranslatableAxiomException The Class UntranslatableAxiomException.

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,String>	ANNOTATIONPROPERTYMAP The annotation property map.

Constructor Summary

Constructors

Constructor and Description
OWLAPIOwl2Obo(OWLOntologyManager translationManager) Instantiates a new OWLAPI owl2 obo.

Method Summary

Modifier and Type	Method and Description
OBODoc	convert(OWLOntology ont) Convert.
static String	getDataVersion(OWLOntology ontology) Gets the data version.
static String	getIdentifier(IRI iriId) See table 5.9.2.
String	getIdentifier(OWLObject obj) Gets the identifier.
static String	getIdentifierFromObject(OWLObject obj, OWLOntology ont) Retrieve the identifier for a given OWLObject.
static String	getIdentifierFromObject(OWLObject obj, OWLOntology ont, String defaultValue) Retrieve the identifier for a given OWLObject.
OWLOntologyManager	getManager() Gets the manager.
OBODoc	getObodoc() Gets the obodoc.
static String	getOntologyId(IRI iriObj) Gets the ontology id.
static String	getOntologyId(OWLOntology ontology) E.g.
boolean	getStrictConversion() Gets the strict conversion.
Collection<OWLAxiom>	getUntranslatableAxioms() Gets the untranslatable axioms.
boolean	isDiscardUntranslatable() Checks if is discard untranslatable.
boolean	isMuteUntranslatableAxioms()
static List<Clause>	normalizeRelationshipClauses(List<Clause> clauses) Join clauses and its QualifierValue which have the same relationship type and target.
static String	owlObjectToTag(OWLObject obj) Owl object to tag.
void	setDiscardUntranslatable(boolean discardUntranslatable) Sets the discard untranslatable.
void	setManager(OWLOntologyManager manager) Sets the manager.
void	setMuteUntranslatableAxioms(boolean muteUntranslatableAxioms)
void	setObodoc(OBODoc obodoc) Sets the obodoc.
void	setStrictConversion(boolean b) Sets the strict conversion.

Methods inherited from class java.lang.Object

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

Field Detail

ANNOTATIONPROPERTYMAP

@Nonnull
public static final Map<String,String> ANNOTATIONPROPERTYMAP

The annotation property map.

Constructor Detail

OWLAPIOwl2Obo

public OWLAPIOwl2Obo(@Nonnull
                     OWLOntologyManager translationManager)

Instantiates a new OWLAPI owl2 obo.

Parameters:

translationManager - the translation manager

Method Detail

setStrictConversion

public void setStrictConversion(boolean b)

Sets the strict conversion.

Parameters:

b - the new strict conversion

getStrictConversion

public boolean getStrictConversion()

Gets the strict conversion.

Returns:

the strict conversion

isDiscardUntranslatable

public boolean isDiscardUntranslatable()

Checks if is discard untranslatable.

Returns:

the discard untranslatable flag

setDiscardUntranslatable

public void setDiscardUntranslatable(boolean discardUntranslatable)

Sets the discard untranslatable.

Parameters:

discardUntranslatable - the value for discard untranslatable to set

getManager

public OWLOntologyManager getManager()

Gets the manager.

Returns:

the manager

setManager

public void setManager(@Nonnull
                       OWLOntologyManager manager)

Sets the manager.

Parameters:

manager - the new manager

getObodoc

@Nonnull
public OBODoc getObodoc()

Gets the obodoc.

Returns:

the obodoc

setObodoc

public void setObodoc(@Nonnull
                      OBODoc obodoc)

Sets the obodoc.

Parameters:

obodoc - the new obodoc

convert

@Nonnull
public OBODoc convert(@Nonnull
                               OWLOntology ont)

Convert.

Parameters:

ont - the ontology

Returns:

the OBO doc

getUntranslatableAxioms

public Collection<OWLAxiom> getUntranslatableAxioms()

Gets the untranslatable axioms.

Returns:

the untranslatable axioms

getOntologyId

public static String getOntologyId(OWLOntology ontology)

E.g. http://purl.obolibrary.org/obo/go.owl to "go"
if does not match this pattern, then retain original IRI

Parameters:

ontology - the ontology

Returns:

The OBO ID of the ontology

getOntologyId

public static String getOntologyId(@Nonnull
                                   IRI iriObj)

Gets the ontology id.

Parameters:

iriObj - the iri

Returns:

the ontology id

getDataVersion

@Nullable
public static String getDataVersion(@Nonnull
                                              OWLOntology ontology)

Gets the data version.

Parameters:

ontology - the ontology

Returns:

the data version

getIdentifier

@Nullable
public String getIdentifier(OWLObject obj)

Gets the identifier.

Parameters:

obj - the object

Returns:

the identifier

isMuteUntranslatableAxioms

public boolean isMuteUntranslatableAxioms()

Returns:

true if untranslatable axioms should not be logged

setMuteUntranslatableAxioms

public void setMuteUntranslatableAxioms(boolean muteUntranslatableAxioms)

Parameters:

muteUntranslatableAxioms - true disables logging

getIdentifierFromObject

@Nonnull
public static String getIdentifierFromObject(@Nonnull
                                                      OWLObject obj,
                                                      @Nonnull
                                                      OWLOntology ont,
                                                      @Nonnull
                                                      String defaultValue)

Retrieve the identifier for a given OWLObject. This methods uses also shorthand hints to resolve the identifier. Should the translation process encounter a problem or not find an identifier the defaultValue is returned.

Parameters:

obj - the OWLObject to resolve

ont - the target ontology

defaultValue - the value to return in case of an error or no id

Returns:

identifier or the default value

getIdentifierFromObject

@Nullable
public static String getIdentifierFromObject(OWLObject obj,
                                                       @Nonnull
                                                       OWLOntology ont)
                                                throws OWLAPIOwl2Obo.UntranslatableAxiomException

Retrieve the identifier for a given OWLObject. This methods uses also shorthand hints to resolve the identifier. Should the translation process encounter an unexpected axiom an

Parameters:

obj - the OWLObject to resolve

ont - the target ontology

Returns:

identifier or null

Throws:

OWLAPIOwl2Obo.UntranslatableAxiomException - the untranslatable axiom exception OWLAPIOwl2Obo.UntranslatableAxiomException is thrown.

getIdentifier

@Nullable
public static String getIdentifier(@Nullable
                                             IRI iriId)

See table 5.9.2. Translation of identifiers

Parameters:

iriId - the iri id

Returns:

obo identifier or null

owlObjectToTag

@Nullable
public static String owlObjectToTag(OWLObject obj)

Owl object to tag.

Parameters:

obj - the object

Returns:

the string

normalizeRelationshipClauses

@Nonnull
public static List<Clause> normalizeRelationshipClauses(@Nonnull
                                                                 List<Clause> clauses)

Join clauses and its QualifierValue which have the same relationship type and target. Try to resolve conflicts for multiple statements. E.g., min=2 and min=3 is resolved to min=2, or max=2 and max=4 is resolved to max=4. It will not merge conflicting exact cardinality statements. TODO How to merge "all_some", and "all_only"?

Parameters:

clauses - the clauses

Returns:

normalized list of Clause