project35.soa.ontology.sources
Class DefaultSubtreeOntologySource

java.lang.Object
  extended by project35.soa.ontology.sources.AbstractTreeOntologySource
      extended by project35.soa.ontology.sources.DefaultSubtreeOntologySource
All Implemented Interfaces:
java.io.Serializable, OntologySource, TreeOntologySource, ServiceClass

public class DefaultSubtreeOntologySource
extends AbstractTreeOntologySource

used to provide an ontology source that is rooted at a particular node It is used by other ontology sources which support the idea of anchoring a large ontology with seed terms that help reduce the amount of terms displayed to an end-user. for example, suppose an ontology desribed a taxonomy for "animals" but an experiment only used the entries for fruit. It would then make sense to anchor an ontology source so it started at "fruit" rather than include everything under "animals". This is when the source would attempt to create a sub-ontology source.


Copyright (c) 2008 Kevin Garwood for Project35. The original code was developed by Kevin Garwood for the University of Manchester. Revisions have been made for Project35, a project that is independent of that institution. This code is licensed under the Academic Free License version 3.0. The code attribution for the original code is included here:

Copyright (c) Kevin Garwood and University of Manchester 2007. All rights reserved. Licensed under the Academic Free License version 3.0. For more information on the terms and conditions, please see the file "LICENSE" that is included in this distribution.


Version:
1.0
Author:
Kevin Garwood (kgarwood@users.sourceforge.net)
See Also:
Serialized Form

Field Summary
 
Fields inherited from class project35.soa.ontology.sources.AbstractTreeOntologySource
anchorTerms, collator, file, fileName, isSourceWorking, maskValidator, ontologyContext, ontologyServiceMetaData, resourceDirectory, rootTerm, searchResultTerm, url
 
Constructor Summary
DefaultSubtreeOntologySource()
           
 
Method Summary
 java.lang.String getDescription()
           
 OntologyTermProvenance getOntologyTermProvenance(Project35FormContext project35FormContext, OntologyTerm ontologyTerm)
           
 java.lang.String getStatus()
           
 OntologySource getSubOntologySource(Project35FormContext project35FormContext, OntologyContext parameters)
           
 boolean isSourceWorking()
           
 void setDescription(java.lang.String description)
           
 void setRoot(TreeOntologyTerm rootTerm)
           
 void setSourceWorking(boolean isSourceWorking)
           
 void setStatus(java.lang.String status)
           
 void setURL(java.net.URL url)
           
 
Methods inherited from class project35.soa.ontology.sources.AbstractTreeOntologySource
addAnchorTerm, containsTerm, getInitialisationParameters, getOntologyServiceMetaData, getRelatedTerms, getSubOntologySource, getSupportedOntologyRelationships, getTerms, getTreeRoot, initialiseService, isWorking, reviseTreeWithAnchorTerms, search, search, test
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultSubtreeOntologySource

public DefaultSubtreeOntologySource()
Method Detail

setRoot

public void setRoot(TreeOntologyTerm rootTerm)

getStatus

public java.lang.String getStatus()

getDescription

public java.lang.String getDescription()

setStatus

public void setStatus(java.lang.String status)

setDescription

public void setDescription(java.lang.String description)
Overrides:
setDescription in class AbstractTreeOntologySource

isSourceWorking

public boolean isSourceWorking()

setSourceWorking

public void setSourceWorking(boolean isSourceWorking)

setURL

public void setURL(java.net.URL url)

getOntologyTermProvenance

public OntologyTermProvenance getOntologyTermProvenance(Project35FormContext project35FormContext,
                                                        OntologyTerm ontologyTerm)
Specified by:
getOntologyTermProvenance in interface OntologySource
Specified by:
getOntologyTermProvenance in class AbstractTreeOntologySource

getSubOntologySource

public OntologySource getSubOntologySource(Project35FormContext project35FormContext,
                                           OntologyContext parameters)