org.semanticweb.owlapi.model.OWLIndividual Maven / Gradle / Ivy
/*
* This file is part of the OWL API.
*
* The contents of this file are subject to the LGPL License, Version 3.0.
*
* Copyright (C) 2011, The University of Manchester
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/.
*
*
* Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0
* in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.
*
* Copyright 2011, University of Manchester
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.semanticweb.owlapi.model;
import java.util.Map;
import java.util.Set;
/**
* Represents a named or anonymous individual.
*
* @author Matthew Horridge, The University Of Manchester, Bio-Health
* Informatics Group, Date: 25-Oct-2006
*/
public interface OWLIndividual extends OWLObject, OWLPropertyAssertionObject {
/**
* Determines if this individual is an instance of
* {@link org.semanticweb.owlapi.model.OWLNamedIndividual}. Note that this
* method is the dual of {@link #isAnonymous()}.
*
* @return {@code true} if this individual is an instance of
* {@link org.semanticweb.owlapi.model.OWLNamedIndividual} because
* it is a named individuals, otherwise {@code false}
*/
boolean isNamed();
/**
* Determines if this object is an instance of
* {@link org.semanticweb.owlapi.model.OWLAnonymousIndividual} Note that
* this method is the dual of {@link #isNamed()}.
*
* @return {@code true} if this object represents an anonymous individual (
* {@code OWLAnonymousIndividual)} or {@code false} if this object
* represents a named individual ( {@code OWLIndividual})
*/
boolean isAnonymous();
/**
* Obtains this individual as a named individual if it is indeed named.
*
* @return The individual as a named individual
* @throws OWLRuntimeException
* if this individual is anonymous
*/
OWLNamedIndividual asOWLNamedIndividual();
/**
* Obtains this individual an anonymous individual if it is indeed anonymous
*
* @return The individual as an anonymous individual
* @throws OWLRuntimeException
* if this individual is named
*/
OWLAnonymousIndividual asOWLAnonymousIndividual();
/**
* A convenience method, which gets the types of this individual, that
* correspond to the types asserted with axioms in the specified ontology.
*
* @param ontology
* The ontology that should be examined for class assertion axioms in
* order to get the types for this individual.
* @return A set of class expressions that correspond the asserted types of
* this individual in the specified ontology.
*/
Set getTypes(OWLOntology ontology);
/**
* A convenience method that gets the types of this individual by examining
* the specified ontologies.
*
* @param ontologies
* The ontologies to be examined for class assertions
* @return A set of class expressions that represent the types of this
* individual as asserted in the specified ontologies.
*/
Set getTypes(Set ontologies);
/**
* Gets the object property values for this individual.
*
* @param ontology
* The ontology to search for the property values.
* @return A map, which maps object properties to sets of individuals.
*/
Map>
getObjectPropertyValues(OWLOntology ontology);
/**
* Gets the asserted object property values for this individual and the
* specified property.
*
* @param ontology
* The ontology to be examined for axioms that assert property values
* for this individual
* @param property
* The property for which values will be returned.
* @return The set of individuals that are the values of this property. More
* precisely, the set of individuals such that for each individual i
* in the set, is in a property assertion axiom property(this, i) is
* in the specified ontology.
*/
Set getObjectPropertyValues(
OWLObjectPropertyExpression property, OWLOntology ontology);
/**
* Test whether a specific value for a specific object property on this
* individual has been asserted.
*
* @param property
* The property whose values will be examined
* @param individual
* The individual value of the property that will be tested for
* @param ontology
* The ontology to search for the property value
* @return {@code true} if the individual has the specified property value,
* that is, {@code true} if the specified ontology contains an
* object property assertion ObjectPropertyAssertion(property, this,
* individual), otherwise {@code false}
*/
boolean hasObjectPropertyValue(OWLObjectPropertyExpression property,
OWLIndividual individual, OWLOntology ontology);
/**
* Test whether a specific value for a specific data property on this
* individual has been asserted.
*
* @param property
* The property whose values will be examined
* @param value
* The value value of the property that will be tested for
* @param ontology
* The ontology to search for the property value
* @return {@code true} if the individual has the specified property value,
* that is, {@code true} if the specified ontology contains a data
* property assertion DataPropertyAssertion(property, this, value),
* otherwise {@code false}
*/
boolean hasDataPropertyValue(OWLDataPropertyExpression property,
OWLLiteral value, OWLOntology ontology);
/**
* Test whether a specific value for a specific object property has been
* asserted not to hold for this individual.
*
* @param property
* The property to test for
* @param individual
* The value to test for
* @param ontology
* The ontology to search for the assertion
* @return {@code true} if the specified property value has explicitly been
* asserted not to hold, that is, {@code true} if the specified
* ontology contains a negative object property assertion
* NegativeObjectPropertyAssertion(property, this, individual),
* otherwise {@code false}
*/
boolean hasNegativeObjectPropertyValue(
OWLObjectPropertyExpression property, OWLIndividual individual,
OWLOntology ontology);
/**
* Gets the object property values that are explicitly asserted NOT to hold
* for this individual
*
* @param ontology
* The ontology that should be examined for axioms
* @return A map containing the negative object property values
*/
Map>
getNegativeObjectPropertyValues(OWLOntology ontology);
/**
* Gets the data property values for this individual
*
* @param ontology
* the ontology to check
* @return a map between property and set of values
*/
Map> getDataPropertyValues(
OWLOntology ontology);
/**
* Gets the values that this individual has for a specific data property
*
* @param ontology
* The ontology to examine for property assertions
* @param property
* the property
* @return The values that this individual has for the specified property in
* the specified ontology. This is the set of values such that each
* value LV in the set is in an axiom of the form
* DataPropertyAssertion(property, thisIndividual, LV) in the
* ontology specified by the ontology parameter.
*/
Set getDataPropertyValues(OWLDataPropertyExpression property,
OWLOntology ontology);
/**
* Gets the data property values that are explicitly asserted NOT to hold
* for this individual
*
* @param ontology
* The ontology that should be examined for axioms
* @return A map containing the negative data property values
*/
Map>
getNegativeDataPropertyValues(OWLOntology ontology);
/**
* Test whether a specific value for a specific data property has been
* asserted not to hold for this individual.
*
* @param property
* The property to test for
* @param literal
* The value to test for
* @param ontology
* The ontology to search for the assertion
* @return {@code true} if the specified property value has explicitly been
* asserted not to hold, that is, {@code true} if the specified
* ontology contains a negative data property assertion
* NegativeDataPropertyAssertion(property, this, literal), otherwise
* {@code false}
*/
boolean hasNegativeDataPropertyValue(OWLDataPropertyExpression property,
OWLLiteral literal, OWLOntology ontology);
/**
* @param ontology
* the ontology to use A convenience method that examines axioms in
* ontology to determine the individuals that are asserted to be the
* same as this individual.
* @return Individuals that have been asserted to be the same as this
* individual.
*/
Set getSameIndividuals(OWLOntology ontology);
/**
* A convenience method that examines axioms in the specified ontology to
* determine the individuals that are asserted to be different to this
* individual.
*
* @param ontology
* the ontology
* @return the set of different individuals
*/
Set getDifferentIndividuals(OWLOntology ontology);
/**
* Returns a string representation that can be used as the ID of this
* individual. This is the toString representation of the node ID of this
* individual
*
* @return A string representing the toString of the node ID of this entity.
*/
String toStringID();
/**
* @param visitor
* visitor to accept
*/
void accept(OWLIndividualVisitor visitor);
/**
* @param visitor
* visitor to accept
* @return visitor ex type
* @param
* return type
*/
O accept(OWLIndividualVisitorEx visitor);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy