OWLEntityCollector (OWLAPI Model Interfaces and utilities 3.4.5 API)

java.lang.Object
- org.semanticweb.owlapi.util.OWLEntityCollector

All Implemented Interfaces:

OWLAnnotationAxiomVisitor, OWLAnnotationObjectVisitor, OWLAnnotationValueVisitor, OWLAxiomVisitor, OWLClassExpressionVisitor, OWLDataRangeVisitor, OWLDataVisitor, OWLEntityVisitor, OWLIndividualVisitor, OWLObjectVisitor, OWLPropertyExpressionVisitor, SWRLObjectVisitor
```
public class OWLEntityCollector
extends Object
implements OWLObjectVisitor, SWRLObjectVisitor
```
Author: Matthew Horridge
The University Of Manchester
Bio-Health Informatics Group
Date: 13-Nov-2006

A utility class that visits axioms, class expressions etc. and accumulates the named objects that are referred to in those axioms, class expressions etc. For example, if the collector visited the axiom (propP some C) subClassOf (propQ some D), it would contain the objects propP, C, propQ and D.

Constructor Summary

Constructors
Constructor and Description
`OWLEntityCollector()` Deprecated.
`OWLEntityCollector(Set<OWLEntity> toReturn)`
`OWLEntityCollector(Set<OWLEntity> toReturn, Collection<OWLAnonymousIndividual> anonsToReturn)`

Method Summary

Methods
Modifier and Type	Method and Description
`Set<OWLAnonymousIndividual>`	`getAnonymousIndividuals()` Deprecated.
`Set<OWLEntity>`	`getObjects()` Deprecated.
`protected void`	`processAxiomAnnotations(OWLAxiom ax)`
`void`	`reset(Set<OWLEntity> toReturn)` Clears all objects that have accumulated during the course of visiting axioms, class expressions etc.
`void`	`setCollectClasses(boolean collectClasses)`
`void`	`setCollectDataProperties(boolean collectDataProperties)`
`void`	`setCollectDatatypes(boolean collectDatatypes)`
`void`	`setCollectIndividuals(boolean collectIndividuals)`
`void`	`setCollectObjectProperties(boolean collectObjectProperties)`
`void`	`visit(IRI iri)`
`void`	`visit(OWLAnnotation annotation)`
`void`	`visit(OWLAnnotationAssertionAxiom axiom)`
`void`	`visit(OWLAnnotationProperty property)`
`void`	`visit(OWLAnnotationPropertyDomainAxiom axiom)`
`void`	`visit(OWLAnnotationPropertyRangeAxiom axiom)`
`void`	`visit(OWLAnonymousIndividual individual)`
`void`	`visit(OWLAsymmetricObjectPropertyAxiom axiom)`
`void`	`visit(OWLClass desc)`
`void`	`visit(OWLClassAssertionAxiom axiom)`
`void`	`visit(OWLDataAllValuesFrom desc)`
`void`	`visit(OWLDataComplementOf node)`
`void`	`visit(OWLDataExactCardinality desc)`
`void`	`visit(OWLDataHasValue desc)`
`void`	`visit(OWLDataIntersectionOf node)`
`void`	`visit(OWLDataMaxCardinality desc)`
`void`	`visit(OWLDataMinCardinality desc)`
`void`	`visit(OWLDataOneOf node)`
`void`	`visit(OWLDataProperty property)`
`void`	`visit(OWLDataPropertyAssertionAxiom axiom)`
`void`	`visit(OWLDataPropertyDomainAxiom axiom)`
`void`	`visit(OWLDataPropertyRangeAxiom axiom)`
`void`	`visit(OWLDataSomeValuesFrom desc)`
`void`	`visit(OWLDatatype datatype)`
`void`	`visit(OWLDatatypeDefinitionAxiom axiom)`
`void`	`visit(OWLDatatypeRestriction node)`
`void`	`visit(OWLDataUnionOf node)`
`void`	`visit(OWLDeclarationAxiom axiom)`
`void`	`visit(OWLDifferentIndividualsAxiom axiom)`
`void`	`visit(OWLDisjointClassesAxiom axiom)`
`void`	`visit(OWLDisjointDataPropertiesAxiom axiom)`
`void`	`visit(OWLDisjointObjectPropertiesAxiom axiom)`
`void`	`visit(OWLDisjointUnionAxiom axiom)`
`void`	`visit(OWLEquivalentClassesAxiom axiom)`
`void`	`visit(OWLEquivalentDataPropertiesAxiom axiom)`
`void`	`visit(OWLEquivalentObjectPropertiesAxiom axiom)`
`void`	`visit(OWLFacetRestriction node)`
`void`	`visit(OWLFunctionalDataPropertyAxiom axiom)`
`void`	`visit(OWLFunctionalObjectPropertyAxiom axiom)`
`void`	`visit(OWLHasKeyAxiom axiom)`
`void`	`visit(OWLInverseFunctionalObjectPropertyAxiom axiom)`
`void`	`visit(OWLInverseObjectPropertiesAxiom axiom)`
`void`	`visit(OWLIrreflexiveObjectPropertyAxiom axiom)`
`void`	`visit(OWLLiteral node)`
`void`	`visit(OWLNamedIndividual individual)`
`void`	`visit(OWLNegativeDataPropertyAssertionAxiom axiom)`
`void`	`visit(OWLNegativeObjectPropertyAssertionAxiom axiom)`
`void`	`visit(OWLObjectAllValuesFrom desc)`
`void`	`visit(OWLObjectComplementOf desc)`
`void`	`visit(OWLObjectExactCardinality desc)`
`void`	`visit(OWLObjectHasSelf desc)`
`void`	`visit(OWLObjectHasValue desc)`
`void`	`visit(OWLObjectIntersectionOf desc)`
`void`	`visit(OWLObjectInverseOf expression)`
`void`	`visit(OWLObjectMaxCardinality desc)`
`void`	`visit(OWLObjectMinCardinality desc)`
`void`	`visit(OWLObjectOneOf desc)`
`void`	`visit(OWLObjectProperty property)`
`void`	`visit(OWLObjectPropertyAssertionAxiom axiom)`
`void`	`visit(OWLObjectPropertyDomainAxiom axiom)`
`void`	`visit(OWLObjectPropertyRangeAxiom axiom)`
`void`	`visit(OWLObjectSomeValuesFrom desc)`
`void`	`visit(OWLObjectUnionOf desc)`
`void`	`visit(OWLOntology ontology)`
`void`	`visit(OWLReflexiveObjectPropertyAxiom axiom)`
`void`	`visit(OWLSameIndividualAxiom axiom)`
`void`	`visit(OWLSubAnnotationPropertyOfAxiom axiom)`
`void`	`visit(OWLSubClassOfAxiom axiom)`
`void`	`visit(OWLSubDataPropertyOfAxiom axiom)`
`void`	`visit(OWLSubObjectPropertyOfAxiom axiom)`
`void`	`visit(OWLSubPropertyChainOfAxiom axiom)`
`void`	`visit(OWLSymmetricObjectPropertyAxiom axiom)`
`void`	`visit(OWLTransitiveObjectPropertyAxiom axiom)`
`void`	`visit(SWRLBuiltInAtom node)`
`void`	`visit(SWRLClassAtom node)`
`void`	`visit(SWRLDataPropertyAtom node)`
`void`	`visit(SWRLDataRangeAtom node)`
`void`	`visit(SWRLDifferentIndividualsAtom node)`
`void`	`visit(SWRLIndividualArgument node)`
`void`	`visit(SWRLLiteralArgument node)`
`void`	`visit(SWRLObjectPropertyAtom node)`
`void`	`visit(SWRLRule rule)`
`void`	`visit(SWRLSameIndividualAtom node)`
`void`	`visit(SWRLVariable node)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OWLEntityCollector
```
public OWLEntityCollector(Set<OWLEntity> toReturn,
                  Collection<OWLAnonymousIndividual> anonsToReturn)
```
    Parameters:
    toReturn - the set that will contain the results
    anonsToReturn - the set that will contain the anon individuals
  - OWLEntityCollector
```
public OWLEntityCollector(Set<OWLEntity> toReturn)
```
    Parameters:
    toReturn - the set that will contain the results
  - OWLEntityCollector
```
@Deprecated
public OWLEntityCollector()
```
    Deprecated.
    
    Deprecated default constructor: use one of the other constructors to get more efficient set creation
- Method Detail
  - reset
```
public void reset(Set<OWLEntity> toReturn)
```
    Clears all objects that have accumulated during the course of visiting axioms, class expressions etc.
    
    Parameters:
    toReturn - the set that will contain the results
  - setCollectClasses
```
public void setCollectClasses(boolean collectClasses)
```
    Parameters:
    collectClasses - true to collect classes
  - setCollectObjectProperties
```
public void setCollectObjectProperties(boolean collectObjectProperties)
```
    Parameters:
    collectObjectProperties - true to collect object properties
  - setCollectDataProperties
```
public void setCollectDataProperties(boolean collectDataProperties)
```
    Parameters:
    collectDataProperties - true to collect data properties
  - setCollectIndividuals
```
public void setCollectIndividuals(boolean collectIndividuals)
```
    Parameters:
    collectIndividuals - true to collect individuals
  - setCollectDatatypes
```
public void setCollectDatatypes(boolean collectDatatypes)
```
    Parameters:
    collectDatatypes - true to collect datatypes
  - getObjects
```
@Deprecated
public Set<OWLEntity> getObjects()
```
    Deprecated.
    
    Gets the objects that are used by all axioms, class expressions etc. that this collector has visited since it was constructed or reset. Deprecated: if the non deprecated constructors are used, this method is useless and inefficient
    
    Returns:
    A set of entities. This will be a copy.
  - getAnonymousIndividuals
```
@Deprecated
public Set<OWLAnonymousIndividual> getAnonymousIndividuals()
```
    Deprecated.
    
    A convenience method. Although anonymous individuals are not entities they are collected by this collector and stored in a separate set. This method returns collected individuals. Deprecated: if the non deprecated constructors are used, this method is useless and inefficient
    
    Returns:
    The set of anonymous individuals that were collected by the collector
  - processAxiomAnnotations
```
protected void processAxiomAnnotations(OWLAxiom ax)
```
  - visit
```
public void visit(OWLSubClassOfAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLNegativeObjectPropertyAssertionAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLAsymmetricObjectPropertyAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLReflexiveObjectPropertyAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLDisjointClassesAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLDataPropertyDomainAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLObjectPropertyDomainAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLEquivalentObjectPropertiesAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLNegativeDataPropertyAssertionAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLDifferentIndividualsAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLDisjointDataPropertiesAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLDisjointObjectPropertiesAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLObjectPropertyRangeAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLObjectPropertyAssertionAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLFunctionalObjectPropertyAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLSubObjectPropertyOfAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLDisjointUnionAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLDeclarationAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLSymmetricObjectPropertyAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLDataPropertyRangeAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLFunctionalDataPropertyAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLEquivalentDataPropertiesAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLClassAssertionAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLEquivalentClassesAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLDataPropertyAssertionAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLTransitiveObjectPropertyAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLIrreflexiveObjectPropertyAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLSubDataPropertyOfAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLInverseFunctionalObjectPropertyAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLSameIndividualAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLSubPropertyChainOfAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLInverseObjectPropertiesAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLHasKeyAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(OWLClass desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
    
    Specified by:
    
    visit in interface OWLEntityVisitor
  - visit
```
public void visit(OWLObjectIntersectionOf desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLObjectUnionOf desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLObjectComplementOf desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLObjectSomeValuesFrom desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLObjectAllValuesFrom desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLObjectHasValue desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLObjectMinCardinality desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLObjectExactCardinality desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLObjectMaxCardinality desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLObjectHasSelf desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLObjectOneOf desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLDataSomeValuesFrom desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLDataAllValuesFrom desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLDataHasValue desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLDataMinCardinality desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLDataExactCardinality desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLDataMaxCardinality desc)
```
    Specified by:
    
    visit in interface OWLClassExpressionVisitor
  - visit
```
public void visit(OWLDataComplementOf node)
```
    Specified by:
    
    visit in interface OWLDataRangeVisitor
  - visit
```
public void visit(OWLDataOneOf node)
```
    Specified by:
    
    visit in interface OWLDataRangeVisitor
  - visit
```
public void visit(OWLDataIntersectionOf node)
```
    Specified by:
    
    visit in interface OWLDataRangeVisitor
  - visit
```
public void visit(OWLDataUnionOf node)
```
    Specified by:
    
    visit in interface OWLDataRangeVisitor
  - visit
```
public void visit(OWLDatatypeRestriction node)
```
    Specified by:
    
    visit in interface OWLDataRangeVisitor
  - visit
```
public void visit(OWLFacetRestriction node)
```
    Specified by:
    
    visit in interface OWLDataVisitor
  - visit
```
public void visit(OWLLiteral node)
```
    Specified by:
    
    visit in interface OWLAnnotationValueVisitor
    
    Specified by:
    
    visit in interface OWLDataVisitor
  - visit
```
public void visit(OWLObjectInverseOf expression)
```
    Specified by:
    
    visit in interface OWLPropertyExpressionVisitor
  - visit
```
public void visit(OWLObjectProperty property)
```
    Specified by:
    
    visit in interface OWLEntityVisitor
    
    Specified by:
    
    visit in interface OWLPropertyExpressionVisitor
  - visit
```
public void visit(OWLDataProperty property)
```
    Specified by:
    
    visit in interface OWLEntityVisitor
    
    Specified by:
    
    visit in interface OWLPropertyExpressionVisitor
  - visit
```
public void visit(OWLNamedIndividual individual)
```
    Specified by:
    
    visit in interface OWLEntityVisitor
    
    Specified by:
    
    visit in interface OWLIndividualVisitor
  - visit
```
public void visit(OWLDatatype datatype)
```
    Specified by:
    
    visit in interface OWLDataRangeVisitor
    
    Specified by:
    
    visit in interface OWLEntityVisitor
  - visit
```
public void visit(OWLAnnotation annotation)
```
    Specified by:
    
    visit in interface OWLAnnotationObjectVisitor
  - visit
```
public void visit(OWLAnnotationAssertionAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAnnotationAxiomVisitor
  - visit
```
public void visit(OWLAnonymousIndividual individual)
```
    Specified by:
    
    visit in interface OWLAnnotationValueVisitor
    
    Specified by:
    
    visit in interface OWLIndividualVisitor
  - visit
```
public void visit(IRI iri)
```
    Specified by:
    
    visit in interface OWLAnnotationValueVisitor
  - visit
```
public void visit(OWLOntology ontology)
```
    Specified by:
    
    visit in interface OWLObjectVisitor
  - visit
```
public void visit(OWLAnnotationProperty property)
```
    Specified by:
    
    visit in interface OWLEntityVisitor
  - visit
```
public void visit(OWLAnnotationPropertyDomainAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAnnotationAxiomVisitor
  - visit
```
public void visit(OWLAnnotationPropertyRangeAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAnnotationAxiomVisitor
  - visit
```
public void visit(OWLSubAnnotationPropertyOfAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAnnotationAxiomVisitor
  - visit
```
public void visit(OWLDatatypeDefinitionAxiom axiom)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
  - visit
```
public void visit(SWRLRule rule)
```
    Specified by:
    
    visit in interface OWLAxiomVisitor
    
    Specified by:
    
    visit in interface SWRLObjectVisitor
  - visit
```
public void visit(SWRLClassAtom node)
```
    Specified by:
    
    visit in interface SWRLObjectVisitor
  - visit
```
public void visit(SWRLDataRangeAtom node)
```
    Specified by:
    
    visit in interface SWRLObjectVisitor
  - visit
```
public void visit(SWRLObjectPropertyAtom node)
```
    Specified by:
    
    visit in interface SWRLObjectVisitor
  - visit
```
public void visit(SWRLDataPropertyAtom node)
```
    Specified by:
    
    visit in interface SWRLObjectVisitor
  - visit
```
public void visit(SWRLBuiltInAtom node)
```
    Specified by:
    
    visit in interface SWRLObjectVisitor
  - visit
```
public void visit(SWRLVariable node)
```
    Specified by:
    
    visit in interface SWRLObjectVisitor
  - visit
```
public void visit(SWRLIndividualArgument node)
```
    Specified by:
    
    visit in interface SWRLObjectVisitor
  - visit
```
public void visit(SWRLLiteralArgument node)
```
    Specified by:
    
    visit in interface SWRLObjectVisitor
  - visit
```
public void visit(SWRLDifferentIndividualsAtom node)
```
    Specified by:
    
    visit in interface SWRLObjectVisitor
  - visit
```
public void visit(SWRLSameIndividualAtom node)
```
    Specified by:
    
    visit in interface SWRLObjectVisitor

Class OWLEntityCollector

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OWLEntityCollector

OWLEntityCollector

OWLEntityCollector

Method Detail

reset

setCollectClasses

setCollectObjectProperties

setCollectDataProperties

setCollectIndividuals

setCollectDatatypes

getObjects

getAnonymousIndividuals

processAxiomAnnotations

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit

visit