Hozo Core (Hozo Ontology API and Reasoner) Document

Draft Version 2009/03/28

* The lateset information is available at the URL  http://www.hozo.jp

 

This document was compiled as part of the below projects. Publication, reproduction or duplication of this document without the permission of the University of Tokyo Hospital, Osaka University, and Enegate Co, ltd. are therefore prohibited.

 

-FY2006 Special Coordination Funds for Promoting Science and Technology (promotes flexible solutions to critical policy issues)

"Research on the structure of medical knowledge base databases for the analysis of clinical medical data"

(Representative: Kazuhiko OHE, Faculty of Medicine, Tokyo University, Contributors: Riichiro MIZOGUCHI, Osaka University, et al.)

-FY2007 Commission for Promoting Development of Medical Information Systems

"Research and development of medical knowledge base databases for medical information systems"

(Representative: Kazuhiko OHE, Faculty of Medicine, Tokyo University, Contributors: Riichiro MIZOGUCHI, Osaka University, et al.)

 

[Copyright Holders]

Ohe Research Laboratory, Department of Planning Information and Management, University of Tokyo Hospital

The Institute of Scientific and Industrial Research, Osaka University, Mizoguchi Laboratory and Enegate Co, ltd.

 

Copyright (c) 2008, Mizoguchi Lab. and ENEGATE Co., Ltd. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the name of Mizoguchi Lab. nor ENEGATE Co., Ltd. may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY MIZOGUCHI LAB. AND ENEGATE CO., LTD. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MIZOGUCHI LAB. OR ENEGATE CO., LTD. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 

 

 

Packages

jp.hozo.core

Hozo Core package

jp.hozo.core.literal

Includes the standard class used by the Hozo Core package.

jp.hozo.core.util

Includes the class file used by Hozo Core package.

jp.hozo.corex

API using Hozo (Package using Hozo Core)

jp.hozo.corex.util

Includes the class file using the API using Hozo (Package using Hozo Core).

jp.hozo.reasoner

Includes the class file used by Hobo乫s inference mechanism.



All Classes


AnyConcept

AttributeOfRelation

Axiom

AxiomBody

BasicConcept

BasicConceptInstance

BooleanValueConcept

Concept

ConceptInstance

ConceptInstanceModel

ConceptModel

DateValueConcept

DifferentRelationConcept

EqualRelationConcept

ExportHozoToOWL

FileUtility

FloatValueConcept

Glossary

GraphicManager

GraphicObject

HozoInternalException

HozoModelObject

HozoObject

HozoOntologyObject

HZBasicConcept

HZBasicConceptInstance

HZFileUtility

HZGraphicManager

HZGraphicObject

HZModel

HZModelUtility

HZModelUtilitySax

HZOntology

HZOntologyUtility

HZOntologyUtilitySax

HZRConceptRelation

HZRConceptRelationInstance

HZReasoner

HZReasonerException

HZReasonerFactory

HZRelationConcept

HZRoleConcept

HZRoleConceptInstance

HZSearchReasoner

HZSlot

HZSlotInstance

HZTransitionReasoner

HZValidationReasoner

HZWholeConcept

IDManager

InstanceOfRelation

IntegerValueConcept

InvalidValueException

IsaRelation

IsaTreeNodeModel

LargerThanRelationConcept

Model

ModelFactory

ModelUtility

ModelUtilitySax

NotEqualRelationConcept

NumberValueConcept

Ontology

OntologyFactory

OntologyFileInfo

OntologyUtility

OntologyUtilitySax

P_Operator

PartOfRelation

RConceptRelation

RConceptRelationInstance

ReasonerReport

ReasonerResult

Relation

RelationConcept

RelationInstance

RoleConcept

RoleConceptInstance

RoleHolder

RoleHolderInstance

RSlotRelation

RSlotRelationInstance

SameAsRelationConcept

SearchCondition

SearchReport

SearchResult

Slot

SlotInstance

SlotInstanceModel

SlotModel

SpeciesConcept

SpeciesConceptInstance

StringValueConcept

Term

TransitionReport

TransitionResult

UriResource

UriValueConcept

ValidationReport

ValidationResult

ValueConcept

WeakIsaRelation

WholeConcept

XMLUtility


 

 

 

AnyConcept


public class AnyConcept

extends BasicConcept

Any Concept Class.

This class defines Any Concept.

 

Constructor Detail

AnyConcept

public AnyConcept(Ontology ont)

Generates Any Concept (Constructor).

Parameters:

ont - Affiliated ontology

 

AttributeOfRelation


public class AttributeOfRelation

extends Relation

Attribute-of Relation Class.

This class defines Attribute-of Relation.

 

Constructor Detail

AttributeOfRelation

public AttributeOfRelation(Ontology ont)

Generates Attribute-of Relation.

Parameters:

ont - Affiliated Ontology

Method Detail

getAttributeSlot

public Slot getAttributeSlot()

Gets Attribute Slot.

Returns:

Returns Attribute Slot.


setAttributeSlot

public void setAttributeSlot(Slot slot)

Sets Attribute Slot.

Parameters:

slot - Sets Attribute Slot.


getAttributeRoleConcept

public RoleConcept getAttributeRoleConcept()

Gets Role Concept.

Returns:

Returns Role Concept.


setAttributeRoleConcept

public void setAttributeRoleConcept(RoleConcept roleConcept)

Sets Role Concept.

Note) Attribute Role Concept's Dependent Slot is not set.

 

Parameters:

roleConcept - Sets partial Role Concept.


getDependentConcept

public Concept getDependentConcept()

Gets Dependent Concept.

Returns:

Returns Dependent Concept.


getDependentConcept

public void getDependentConcept(Concept concept)

Sets Dependent Concept.

Parameters:

concept - Sets Dependent Concept.


getAttributeSlotSize

public java.lang.String getAttributeSlotSize()

Returns the number of Attribute Slots.

Returns:

Returns the number of Attribute Slots.


setAttributeSlotSize

public void setAttributeSlotSize(java.lang.String size)

Sets the number of Attribute Slots.

Parameters:

size - Sets the number of Attribute Slots.

 

Axiom


public class Axiom

extends java.lang.Object

Axiom Class.

This class defines Axiom.

Note) The implementation is temporary. When a method to describe the axiom is determined, this will be implemented.

 

Constructor Detail

Axiom

public Axiom()

Generates Axiom. (Constructor)

Method Detail

getAxiomBodyList

public java.util.List getAxiomBodyList()

Gets all Axiom contents.

Returns:

Returns all Axiom contents.


addAxiomBody

public void addAxiomBody(AxiomBody axiomBody)

Adds the Axiom contents.

Parameters:

axiomBody - Specifies the Axiom contents to add.


removeAxiomBody

public void removeAxiomBody(AxiomBody axiomBody)

Deletes the Axiom contents.

Parameters:

axiomBody - Specify the Axiom contents to delete.


getAxiomName

public java.lang.String getAxiomName()

Gets Axiom Name.

Returns:

Returns Axiom Name.


setAxiomName

public void setAxiomName(java.lang.String name)

Sets Axiom Name.

Parameters:

name - Sets Axiom Name.


getParticipants

public java.lang.String getParticipants()

Gets Participants.

Returns:

Returns Participants


setParticipants

public void setParticipants(java.lang.String part)

Sets Participants.

Parameters:

part - Sets Participants.

 

AxiomBody


public class AxiomBody

extends java.lang.Object

Axiom Body Class.

This class defines the axiom constraints.

Note) The implementation is temporary. When a method to describe Axiom is determined, this will be implemented.

 

Constructor Detail

AxiomBody

public AxiomBody()

Generates Axiom Body. (Constructor)

Method Detail

getBody

public java.lang.String getBody()

Gets the constraints.

Returns:

Returns the constraints.


setBody

public void setBody(java.lang.String body)

Sets the constraints.

Parameters:

body - Sets the constraints.


getCondition

public java.lang.String getCondition()

Gets Condition.

Returns:

Returns Condition.


setCondition

public void setCondition(java.lang.String condition)

Sets Condition.

Parameters:

condition - Sets _condition.


getUserUse

public java.lang.String getUserUse()

Gets User Use.

Returns:

Returns User Use.


setUserUse

public void setUserUse(java.lang.String userUse)

Sets User Use.

Parameters:

userUse - Sets User Use.


getAxiomBodyName

public java.lang.String getAxiomBodyName()

Gets Axiom Body Name.

Returns:

Returns Axiom Body Name.


setAxiomBodyName

public void setAxiomBodyName(java.lang.String bodyName)

Sets Axiom Body Name.

Parameters:

bodyName - Sets Axiom Body Name.

 

BasicConcept


public class BasicConcept

extends Concept

Basic Concept Class.

This class defines Basic Concept.

 

Constructor Detail

BasicConcept

public BasicConcept(Ontology ont)

Generates Basic Concept. (Constructor)

Parameters:

ont - Affiliated Ontology

 

BasicConceptInstance


public class BasicConceptInstance

extends ConceptInstance

Basic Concept Instance Class.

This class defines Basic Concept Instance.

 

Constructor Detail

BasicConceptInstance

public BasicConceptInstance(Model model)

Generates Basic Concept Instance. (Constructor)

Parameters:

model - Specifies Model.

 

BooleanValueConcept


public class BooleanValueConcept

extends ValueConcept

Boolean Value Concept Class.

This class defines Boolean Value Concept.

 

Constructor Detail

BooleanValueConcept

public BooleanValueConcept(Ontology ont)

Generates Boolean Value Concept. (Constructor)

Parameters:

ont - Affiliated Ontology


BooleanValueConcept

public BooleanValueConcept(Ontology ont,

                           java.lang.String value)

Generates Boolean Value Concept. (Constructor)

Parameters:

ont - Affiliated Ontology

value - Specifies Value.

Method Detail

setValue

public void setValue(java.lang.String val)

              throws InvalidValueException

Sets Value.

Overrides:

setValue in class ValueConcept

Parameters:

val - Sets Value.

Throws:

InvalidValueException


isValid

public boolean isValid()

Specifies the boolean if Value is valid

Overrides:

isValid in class ValueConcept

Returns:

Returns the boolean if Value is valid.


isValid

public static boolean isValid(java.lang.String value)

Returns the boolean if Value is valid.

Parameters:

value - Specifies Value.

Returns:

Returns the boolean if Value is valid.

 

 

Concept


public class Concept

extends HozoOntologyObject

Concept Class.

Concept Class.

This class defines Concept.

 

Method Detail

setLabel

public void setLabel(java.lang.String label)

Sets Hozo Object Label. (Override)

Overrides:

setLabel in class HozoObject

Parameters:

label - Sets Hozo Object Label.


isRootConcept

public boolean isRootConcept()

Gets the boolean if the concept is Root Concept.

Returns:

Returns "True" if it is Root Concept, otherwise returns "False".


getRootPath

public java.lang.String getRootPath()

Gets the concept path in string.

Returns:

Returns the concept path (string, "/" delimiter) up to the root.


removeSlot

public void removeSlot(Slot slot)

Deletes Slot.

Parameters:

slot - Sets Slot to delete.


addSlot

public void addSlot(Slot slot)

Adds Slot.

Parameters:

slot - Sets Slot to add.


getSlot

public Slot getSlot(int index)

Get Slot.

Parameters:

index - Slot偺僀儞僨僢僋僗傪愝掕丅

Returns:

Returns specified Slot.


getSlotSize

public int getSlotSize()

Gets the number of Slots.

Returns:

Returns the number of Slots.


getSlotList

public java.util.List getSlotList()

Gets Slot List.

Returns:

Returns Slot List.


getPartOfSlotList

public java.util.List getPartOfSlotList()

Gets the part of Slot List.

Returns:

Returns the part of Slot List.


removeRelation

public void removeRelation(Relation relation)

Deletes Relation.

Parameters:

relation - Sets Relation to delete.


addRelation

public void addRelation(Relation relation)

Adds Relation.

Parameters:

relation - Sets Relation to add.


getRelationList

public java.util.List getRelationList()

Gets Relation List.

Returns:

Returns Relation List.


getUpperConcept

public Concept getUpperConcept()

Gets Super Concept.

Returns:

Returns Super Concept.


setUpperConcept

public void setUpperConcept(Concept concept)

Sets Super Concept.

Parameters:

concept - Super Concept.


getType

public int getType()

Gets Concept Type.

Returns:

Returns Concept Type.


setType

protected void setType(int type)

Sets Concept Type.

Parameters:

type - Sets Concept Type.


hasSlots

public boolean hasSlots()

Returns the boolean if Concept has Slot.

Returns:

Returns "True" if Concept has Slot.


hasRelations

public boolean hasRelations()

Returns the boolean if Concept has Relations.

Returns:

Returns "True" if Concept has Relations.


findSlotByLabel

public Slot findSlotByLabel(java.lang.String label)

Search for Slot

Parameters:

label - Slot Label (Format: [Slot name]%[Slot name]%...[Slot name]

Returns:

Returns Slot found.


getLowerConcepts

public java.util.List getLowerConcepts()

Gets Sub-Concept.

Returns:

Returns the inherited Sub-Concept.


getAllLowerConcepts

public java.util.List getAllLowerConcepts()

Gets all Sub-Concepts.

Returns:

Returns all inherited Sub-Concepts.


hasLowerConcept

public boolean hasLowerConcept()

Gets the boolean if Concept has Sub-Concept.

Returns:

Returns "True" if Concept has Sub-Concept.


findSlotsByRoleName

protected java.util.List findSlotsByRoleName(java.lang.String name)

Searches for Slot with Role Name.

Parameters:

name - Specifies Slot Role Name.

Returns:

Returns Slot found.


removeRoleConcept

public void removeRoleConcept(RoleConcept roleConcept)

Deletes Role Concept.

Note) Deleting Role Concept does not delete its dependent Slot.

 

Parameters:

roleConcept - Sets Role Concept to delete.


addRoleConcept

public void addRoleConcept(RoleConcept roleConcept)

Adds Role Concept.

Note) Currently duplication of Role Concept is allowed. Also, adding Role Concept does not add Slot that is dependent on it.

 

Parameters:

roleConcept - Sets Role Concept to add.


getRoleConceptList

public java.util.List getRoleConceptList()

Gets Role Concept List.

Returns:

Returns Role Concept List.


getAncestorConceptList

public java.util.List getAncestorConceptList()

Gets all Super Concepts.

Note) This method was created on 11/04/2005 as a reference.

 

Returns:

Returns Super Concept List.


getAncestorConceptList

public java.util.List getAncestorConceptList(boolean isOrdered)

Gets all Super Concepts.

Parameters:

isOrdered - Specifies if the order is ascending.

Returns:

Returns Super Concept List.


getDescendantConceptList

public java.util.List getDescendantConceptList()

Gets all Sub-Concepts.

Note) This method was created on 05/08/2006 as a reference.

 

Returns:

Returns Sub-Concept list.


isDescendantConcept

public boolean isDescendantConcept(Concept concept)

Gets the boolean if Concept is a descendent of another Concept.

Note) This method was created on 12/15/2005 as a reference.

 

Parameters:

concept - Sets the target Concept.

Returns:

Returns the boolean if Concept is a descendent of the specified Concept.


isAncestorConcept

public boolean isAncestorConcept(Concept concept)

Gets the boolean if Concept is Super-Concept.

Note)  This method was created on 09/12/2008 as a reference.

 

Parameters:

concept - Sets the target Concept.

Returns:

Returns the boolean if the specified Concept is Super Concept.


isExtendedAncestorConcept

public boolean isExtendedAncestorConcept(Concept concept)

Gets the boolean if Concept is a multi-inherited Super Concept.

Note) This method was created on 10/30/2008 as a reference.

 

Parameters:

concept - Sets the target Concept.

Returns:

Returns the boolean if the specified Concept is a multi-inherited Super Concept.


getAllSlotList

public java.util.List getAllSlotList()

Gets all Slots including upper Slots.

Note)  This method was created on 05/15/2006 as a reference.

Including related methods, refactoring is required.

 

Returns:

Returns All Slot List.


getAllExtendedSlotList

public java.util.List getAllExtendedSlotList()

Gets all Slots including upper Slots, including multi-inherited ones.

Note) This method was created on 10/30/2008 as a reference.

 

Returns:

Returns All Slot List.


getSlotList

protected java.util.List getSlotList(Concept concept,

                                     java.util.List slotList)

Gets the Slot List specified in Concept.

Note)  This method was created on 09/13/2008 as a reference.

 

Parameters:

concept - Specifies Concept.

slotList - Specifies Slot List.

Returns:

Returns Slot List specified by Concept.


getAllSlotList

public java.util.List getAllSlotList(boolean isDetail)

Gets All Slots including upper Slots.

Note) This method was created on 09/07/2006 as a reference.

Including related methods, refactoring is required.

 

Parameters:

isDetail - Sets whether to get the Slot Lists of the parent Concept.

Returns:

Returns all Slot Lists.


getEssentialSlotList

public java.util.List getEssentialSlotList(boolean isDetail)

Gets Essential Slot.

Note) This method was created on 09/07/2006 as a reference.

 

Parameters:

isDetail - Sets whether to get related Slots.

Returns:

Returns Essential Slot List.


isSpeciesConcept

public boolean isSpeciesConcept()

Gets the boolean if Concept is set as Class type.

Returns:

Returns the boolean if Concept should be set as a Concept type.


setSpeciesConcept

public void setSpeciesConcept(boolean isSpeciesConcept)

Sets whether Concept should be set as Class.

Parameters:

isSpeciesConcept - Sets the boolean if Concept should be set as a Concept type.


getExtendedUpperConcepts

public java.util.List getExtendedUpperConcepts()

Gets multi-inherited Super Concept list.

Returns:

Returns multi-inherited Super Concept list.


getAllExtendedUpperConcepts

public java.util.List getAllExtendedUpperConcepts()

Gets all multi-inherited Super Concepts.

Returns:

Returns all multi-inherited Super Concepts.


addExtendedUpperConcept

public void addExtendedUpperConcept(Concept concept)

Adds a multi-inherited Super Concept.

Parameters:

concept - Specifies the multi-inherited Super Concept.


removeExtendedUpperConcept

public void removeExtendedUpperConcept(Concept concept)

Deletes the multi-inherited Super Concept.

Parameters:

concept - Specifies the multi-inherited Super Concept.


isExtendedUpperConcept

public boolean isExtendedUpperConcept(Concept concept)

Gets the boolean if Concept is a multi-inherited Super Concept.

Parameters:

concept - Specifies Concept.


hasExtendedUpperConcept

public boolean hasExtendedUpperConcept()

Gets the boolean if it has a multi-inherited Super Concept.

Returns:

Returns the boolean if it has a multi-inherited Super Concept.


getExtendedLowerConcepts

public java.util.List getExtendedLowerConcepts()

Gets the multi-inherited Sub-Concept list.

Returns:

Returns the multi-inherited Sub-Concept list.


getAllExtendedLowerConcepts

public java.util.List getAllExtendedLowerConcepts()

Gets all multi-inherited Sub-Concepts.

Returns:

Returns all multi-inherited Sub-Concepts.


addExtendedLowerConcept

public void addExtendedLowerConcept(Concept concept)

Adds a multi-inherited Sub-Concept.

Parameters:

concept - Specifies the multi-inherited Sub-Concept.


removeExtendedLowerConcept

public void removeExtendedLowerConcept(Concept concept)

Deletes the multi-inherited Sub-Concept.

Parameters:

concept - Specifies the multi-inherited Sub-Concept.


isExtendedLowerConcept

public boolean isExtendedLowerConcept(Concept concept)

Gets the boolean if Concept is a multi-inherited Sub-Concept.

Parameters:

concept - Specifies Concept.


hasExtendedLowerConcept

public boolean hasExtendedLowerConcept()

Gets the boolean if it has a multi-inherited Sub-Concept.

Returns:

Returns the boolen if it has a multi-inherited Sub-Concept.


isUnique

public boolean isUnique()

Gets the boolean if Concept is a sole Concept (Instantiation of the Concept).

Returns:

Returns the boolean if Concept is a sole Concept (Instantiation of the Concept).


setUnique

public void setUnique(boolean isUnique)

Sets the boolen if Concept is the only concept (Instantiation of the Concept).

Parameters:

isUnique - Specifies if Concept is only concept (Instantiation of the Concept).


getTerms

public java.util.List getTerms()

Gets the list in the other name.

Returns:

Returns the list in the other name.


addTerm

public void addTerm(Term term)

Adds the other name.

Parameters:

term - Specifies the other name.


removeTerm

public void removeTerm(Term term)

Deletes the other name.

Parameters:

term - Specifies the other name.


hasTerms

public boolean hasTerms()

Gets the boolean if it has another name.

Returns:

Returns the boolen if it has another name.


getConcept

protected static Concept getConcept(Concept concept)

Gets Concept. *For Role Holder or p-operator.

Parameters:

Specifies Concept.

Returns:

Returns Concept.


canOverRide

protected boolean canOverRide(java.util.List slotList,

                              Slot slot)

Gets the boolen if Slot can be added.

Parameters:

slotList - Specifies Slot List.

slot - Specifies Concept.

Returns:

Returns the boolean if Slot can be added.


getExtendedAncestorConceptList

public java.util.List getExtendedAncestorConceptList()

Gets all multi-inherited Super Concepts.

Returns:

Returns the multi-inherited Super Concepts.


isSibling

public boolean isSibling(Concept concept)

Gets the boolean if Concept is a sibling.

Parameters:

concept - Specifies Concept.

Returns:

Returns the boolean if Concept is a sibling.


isFamily

public boolean isFamily(Concept concept)

Gets the boolean if Concept is a family member.

Parameters:

concept - Specifies Concept.

Returns:

Returns the boolen if Concept is a family member.

 

 

ConceptInstance


public class ConceptInstance

extends HozoModelObject

Concept Instance Class.

This Class defines Concept Instance.

 

Constructor Detail

ConceptInstance

public ConceptInstance(Model model)

Creates Concept Instance (Constructor)

Parameters:

model - Specifies Model.


ConceptInstance

public ConceptInstance(Model model,

                       int type)

Creates Concept Instance.

Normally, the default Constructor is used.

 If Concept is specified as a temporary Concept Instance, specify type=0 to create the instance.

 This can be distinguished from normal Concept Instance.

 

Parameters:

model - Specifies Model.

type - Specifies Model Type.

Method Detail

removeSlotInstance

public void removeSlotInstance(SlotInstance slotInstance)

Deletes Slot Instance.

Parameters:

slotinstance - Sets Slot Instance to delete.


addSlotInstance

public void addSlotInstance(SlotInstance slotIns)

Adds Slot Instance.

Parameters:

slotIns - Sets Slot Instance to add.


getSlotInstance

public SlotInstance getSlotInstance(int index)

Gets Slot Instance.

Parameters:

index - Sets Slot Instance Index.

Returns:

Returns the specified Slot Instance.


getSlotInstanceSize

public int getSlotInstanceSize()

Gets the number of Slot Instances.

Returns:

Returns the number of Slot Instances.


getSlotInstanceList

public java.util.List getSlotInstanceList()

Gets Slot Instance List.

Returns:

Returns Slot Instance List.


removeRelationInstance

public void removeRelationInstance(RelationInstance relationInstance)

Deletes Relation Instance.

Parameters:

relationInstance - Sets Relation Instance to delete.


addRelationInstance

public void addRelationInstance(RelationInstance relationInstance)

Adds Relation Instance.

Parameters:

relationInstance - Sets Relation Instance.


getRelationInstanceList

public java.util.List getRelationInstanceList()

Gets Relation Instance List.

Returns:

Returns Relation Instance List.


getType

public int getType()

Gets Concept Instance Type

Returns:

Returns Concept Instance Type.


setType

protected void setType(int type)

Sets Concept Instance Type

Parameters:

type - Sets Concept Instance Type.


hasSlotInstances

public boolean hasSlotInstances()

Returns the boolean if it has Slot Instance.

Returns:

Returns "True" if it has Slot Instance.


getReferenceConcept

public Concept getReferenceConcept()

Gets Reference Concept.

Returns:

Returns Reference Concept.


setReferenceConcept

public void setReferenceConcept(Concept concept)

Sets Reference Concept.

Parameters:

concept - Sets Reference Concept.


getModel

public Model getModel()

Gets the affiliated Model.

Overrides:

getModel in class HozoModelObject

Returns:

Returns the affiliated Model.


setModel

public void setModel(Model model)

Sets the affiliated Model.

Parameters:

model - Sets the affiliated Model.


removeRoleConceptInstance

public void removeRoleConceptInstance(RoleConceptInstance roleConceptIns)

Deletes Role Concept Instance.

Parameters:

roleConceptIns - Sets Role Concept Instance to delete.


addRoleConceptInstance

public void addRoleConceptInstance(RoleConceptInstance roleConceptIns)

Adds the Role Concept Instance.

Note) Currently duplication of Role Concept Instance is allowed.

 

Parameters:

roleConceptIns - Sets Role Concept Instance to add.


getRoleConceptInstanceList

public java.util.List getRoleConceptInstanceList()

Gets Role Concept Instance List.

Returns:

Returns the Role Concept Instance List.


hasRelationInstances

public boolean hasRelationInstances()

Returns the boolean if it has Relation Instance.

Returns:

Returns "True" if it has Relation Instance.


isDescendantConceptInstance

public boolean isDescendantConceptInstance(ConceptInstance conceptIns)

Gets the boolean if it is a descendant of Concept Instance.

Note) This method was created on 12/15/2005 as a reference.

 

Parameters:

conceptIns - Sets the target Concept Instance.

Returns:

Returns the boolean if it is a descendent of the specified Concept Instance.


getSlotInstanceList

public java.util.List getSlotInstanceList(Slot slot)

Gets Slot Instance List.

Note) This method was created on 05/02/2006 as a reference.

 

Parameters:

slot - Sets the target Slot.

Returns:

Returns the target Slot List.


getSlotInstanceSize

public int getSlotInstanceSize(Slot slot)

Gets the number of Instances of a Slot.

Note) This method was created on 05/02/2006 as a reference.

 

Parameters:

slot - Sets the target Slot.

Returns:

Returns the number of target Slots.

 

 

ConceptInstanceModel


public interface ConceptInstanceModel

Concept Instance Model Class.

This class defines Concept Instance Model.

 

Method Detail

createSlotInstance

SlotInstance createSlotInstance(Slot slot,

                                ConceptInstance constConIns)

Creates Slot Instance.

Parameters:

slot - Specifies the target Slot.

constConIns - Specifies the constraint Concept Instance.

Returns:

Returns Slot Instance created.

 

 

ConceptModel


public interface ConceptModel

Concept Model Class

This class defines Concept Model.

 

Method Detail

createPartOfSlot

Slot createPartOfSlot(java.lang.String roleName,

                      java.lang.String roleHolderName,

                      java.lang.String strCardinality,

                      java.lang.String strClassConst,

                      java.lang.String strConstValue)

Creates a partial Slot.

Parameters:

roleName - Specifies Role Name.

roleHolderName - Specifies Role Holder Name.

strCardinality - Specifies Cardinality in string.

strClassConst - Specifies Class Constraint in string.

strConstValue - Specifies Constraint Value in string.

Returns:

Returns Slot created.


createAttributeOfSlot

Slot createAttributeOfSlot(java.lang.String roleName,

                           java.lang.String roleHolderName,

                           java.lang.String strCardinality,

                           java.lang.String strClassConst,

                           java.lang.String strConstValue)

Creates Attribute Of Slot.

Parameters:

roleName - Specifies Role Name.

roleHolderName - Specifies Role Holder Name.

strCardinality - SpecifiesCardinality in string.

strClassConst - Specifies Class Constraint in string.

strConstValue - Specifies Constraint Value in string.

Returns:

Returns Slot created.


createOverrideSlot

Slot createOverrideSlot(Slot slot,

                        boolean createSlotOfSlot)

Creates a specialized Slot.

Returns NULL if a specified Slot cannot be specialized.

 

Parameters:

slot - Specifies Slot.

createSlotOfSlot - Specifies if Slot-Of-Slot should be created.

Returns:

Returns Slot created.


addSubConcept

Concept addSubConcept(Concept concept)

Adds Sub-Concept.

Parameters:

concept - Specifies Concept.

Returns:

Returns Sub-Concept added.


getSuperClassLabels

java.lang.String[] getSuperClassLabels()

Gets Super Class Labels in string.

Returns:

Retursn Super Class Labels in string.


getSuperClassList

java.util.List getSuperClassList()

Gets Super Class List in list.

Returns:

Returns Super Class List in list.


getSubClassLabels

java.lang.String[] getSubClassLabels()

Gets Sub Class List in string.

Returns:

ReturnsSub Class List in string.


getSubClassList

java.util.List getSubClassList()

Gets Sub Class List in list.

Returns:

Returns Sub Class List in list.

 

 

DateValueConcept


public class DateValueConcept

extends ValueConcept

Date Value Concept Class.

 This class defines Date Value Concept.

 

Constructor Detail

DateValueConcept

public DateValueConcept(Ontology ont)

Creates Date Value Concept. (Constructor)

Parameters:

ont - Affiliated Ontology


DateValueConcept

public DateValueConcept(Ontology ont,

                        java.lang.String value)

Creates Date Value Concept. (Constructor)

Parameters:

ont - Affiliated Ontology

value - Specifies Value.

Method Detail

setValue

public void setValue(java.lang.String val)

              throws InvalidValueException

Sets Value.

Overrides:

setValue in class ValueConcept

Parameters:

val - Sets Value.

Throws:

InvalidValueException


isValid

public boolean isValid()

Returns the boolean if Value is valid.

Overrides:

isValid in class ValueConcept

Returns:

Returns the boolean if Value is valid.


isValid

public static boolean isValid(java.lang.String value)

Returns the boolean if Value is valid.

Parameters:

value - Specifies Value.

Returns:

Returns the boolean if Value is valid.

 

 

DifferentRelationConcept


public class DifferentRelationConcept

extends RelationConcept

Different Relation Concept Class.

This class defines differentRelation Concept.

 

Constructor Detail

DifferentRelationConcept

public DifferentRelationConcept(Ontology ont)

Creates differentRelation Concept. (Constructor)

Parameters:

ont - Affiliated Ontology

 

EqualRelationConcept


public class EqualRelationConcept

extends RelationConcept

Equal Relation Concept Class.

This class defines equalRelation Concept.

 

Constructor Detail

EqualRelationConcept

public EqualRelationConcept(Ontology ont)

Creates equalRelation Concept. (Constructor)

Parameters:

ont - Affiliated Ontology

 

 

ExportHozoToOWL


public class ExportHozoToOWL

extends java.lang.Object

Hozo OWL output Class.

Constructor Detail

ExportHozoToOWL

public ExportHozoToOWL(Ontology ontology)

Constructor.

Parameters:

ontology - Specifies Ontology.


ExportHozoToOWL

public ExportHozoToOWL(Ontology ontology,

                       java.lang.String encoding)

Constructor

Parameters:

ontology - Specifies Ontology.

encoding - Specifies Encode.


ExportHozoToOWL

public ExportHozoToOWL(Ontology ontology,

                       java.lang.String encoding,

                       int type)

Constructor

Parameters:

ontology - Specifies Ontology.

encoding - Specifies Encode.

type - Specifies the output Type.

Method Detail

exportOWL

public java.lang.String exportOWL(int type)

Outputs the OWL format data.

Parameters:

type - Specifies the output type.

Returns:

Returns the OWL format data.


exportOWL

public java.lang.String exportOWL()

Outputs the OWL format data.

Returns:

Returns the OWL format data.


getOntology

public Ontology getOntology()

Gets Ontology.

Returns:

Returns Ontology.


setOntology

public void setOntology(Ontology ontology)

Sets Ontology.

Parameters:

ontology - Sets Ontology


getEncording

public java.lang.String getEncording()

Gets Encode.

Returns:

Returns Encode.


setEncording

public void setEncording(java.lang.String encoding)

Sets Encode.

Parameters:

encoding - Sets Encode.


getExportType

public int getExportType()

Gets the output type.

Returns:

Returns the output type.


setExportType

public void setExportType(int type)

Sets the output type.

Parameters:

type - Sets the output type.


replaceOWLEscapeChar

public static java.lang.String replaceOWLEscapeChar(java.lang.String str)

Replace OWL Escape Character.

Parameters:

str - Sets the target string.


escapeFullSizeChar

public static java.lang.String escapeFullSizeChar(java.lang.String str)

Replaces Escape Character (Uppercase character -> Lower case character)

Parameters:

str - Sets the target string.


escapeXML

protected static java.lang.String escapeXML(java.lang.String str)

Replaces XML Escape Character.

Parameters:

str - Specifies the string to be saved in the XML file.

Returns:

Returns the replaced string.

 

 

FileUtility


public class FileUtility

extends java.lang.Object

File Processing Utility Class.

This class defines the File I/O process.

 

Method Detail

isFileExists

protected static boolean isFileExists(java.lang.String pathname)

Gets the boolean if the file exists.

Parameters:

pathname - Specifies the file path or URI (URL).

Returns:

Returns the boolean if the file exists.


isURI

public static boolean isURI(java.lang.String uri)

Gets the boolean if it is URI.

Parameters:

uri - Specifies URI (URL).

Returns:

Returns the boolean if it is URI.


isFile

protected static boolean isFile(java.lang.String filename)

Gets the boolean if it is a file name.

Parameters:

filename - Specifies the file name.

Returns:

Returns the boolean if it is a file name.


getFileName

protected static java.lang.String getFileName(java.lang.String filepath)

Gets the file name.

Parameters:

filepath - Specifies the file path.

Returns:

Returns the file name.


getFilePath

protected static java.lang.String getFilePath(java.lang.String pathname)

Gets the file path.

Parameters:

pathname - Specifies the file path or URI (URL).

Returns:

Returns the file path.


escapeXML

protected static java.lang.String escapeXML(java.lang.String str)

Replaces XML Escape Character.

Parameters:

str - Specifies the string to save in the XML file.

Returns:

Returns the replaced string.


isTabooFileName

protected static boolean isTabooFileName(java.lang.String str)

Determines if an illegal character is used in the file name.

Parameters:

str - Specifies the string to set as the file name.

Returns:

Returns the boolean if an illegal character is used.

 

FloatValueConcept


public class FloatValueConcept

extends ValueConcept

Flat Value Concept Class.

This class defines the FloatValue Concept.

 

Constructor Detail

FloatValueConcept

public FloatValueConcept(Ontology ont)

Creates the Float Value Concept. (Constructor)

Parameters:

ont - Affliated Ontology


FloatValueConcept

public FloatValueConcept(Ontology ont,

                         java.lang.String value)

Creates Float Value Concept. (Constructor)

Parameters:

ont - Affiliated Ontology

value - Specifies Value.

Method Detail

setValue

public void setValue(java.lang.String val)

              throws InvalidValueException

Sets Value.

Overrides:

setValue in class ValueConcept

Parameters:

val - Sets Value.

Throws:

InvalidValueException


isValid

public boolean isValid()

Returns the boolean if Value is valid.

Overrides:

isValid in class ValueConcept

Returns:

Returns the boolean if Value is valid.


isValid

public static boolean isValid(java.lang.String value)

Returns the boolean if Value is valid.

Parameters:

value - Specifies Value.

Returns:

Returns the booelean if Value is valid.

 

Glossary


public class Glossary

extends java.lang.Object

Glossary Type class

This class defines Glossary Type used by Hozo.

 

Constructor Detail

Glossary

public Glossary()

Constructor


Glossary

public Glossary(java.lang.String name)

Constructor

Parameters:

name - Specifies Label Name.

Method Detail

getName

public java.lang.String getName()

Gets Label Name

Returns:

Returns Label Name.


setName

public void setName(java.lang.String name)

Sets Label Name.

Parameters:

name - Specifies Label Name.


getUrl

public java.lang.String getUrl()

Gets URL.

Returns:

Returns URL.


setUrl

public void setUrl(java.lang.String url)

Sets URL.

Parameters:

url - Specifies URL.


getLanguage

public java.lang.String getLanguage()

Gets Language.

Returns:

Returns Language.


setLanguage

public void setLanguage(java.lang.String lang)

Sets Language.

Parameters:

lang - Specifies Language.


getSymbol

public java.lang.String getSymbol()

Gets Symbol.

Returns:

_symbol


setSymbol

public void setSymbol(java.lang.String symbol)

Sets Symbol.

Parameters:

symbol - Specifies Symbol.


getDescription

public java.lang.String getDescription()

Gets Description.

Returns:

Returns Description.


setDescription

public void setDescription(java.lang.String description)

Sets Description.

Parameters:

description - Specifies Description.

 

 

GraphicManager


public class GraphicManager

extends java.lang.Object

Graphic Data Management Class.

Manages Graphic Object.

 

Method Detail

getGraphicObject

public GraphicObject getGraphicObject(java.lang.String key)

Gets Graphic Object.

Parameters:

key - Specifies Key.

Returns:

Returns Graphic Object.


putGraphicObject

public void putGraphicObject(java.lang.String key,

                             GraphicObject gobj)

Sets Graphic Object.

Parameters:

key - Specifies Key.

gobj - Specifies Graphic Object.


getAllGraphicObjects

public java.util.Collection getAllGraphicObjects()

Gets all Graphic Objects.

Returns:

Returns the Graphic Object collection.


removeGraphicObject

public void removeGraphicObject(java.lang.String key)

Deletes Graphic Object.

Parameters:

key - Specifies Key.

 

 

GraphicObject


public class GraphicObject

extends java.lang.Object

Graphic Object Class.

Maintains the Graphic Object data of the Hozo object.

 

Constructor Detail

GraphicManager

public GraphicManager()

Constructor

Method Detail

getGraphicObject

public GraphicObject getGraphicObject(java.lang.String key)

Gets Graphic Object.

Parameters:

key- Specifies Key.

Returns:

Returns Graphic Object.


putGraphicObject

public void putGraphicObject(java.lang.String key,

                             GraphicObject gobj)

Sets Graphic Object.

Parameters:

key - Specifies Key.

gobj - Specifies Graphic Object.


getAllGraphicObjects

public java.util.Collection getAllGraphicObjects()

Gets all Graphic Objects.

Returns:

Returns the Graphic Object collection.


removeGraphicObject

public void removeGraphicObject(java.lang.String key)

Deletes Graphic Object.

Parameters:

key - Specifies Key.

 

HozoInternalException


public class HozoInternalException

extends java.lang.Exception

Exception Class for internal error.

Constructor Detail

HozoInternalException

public HozoInternalException()

Constructor


HozoInternalException

public HozoInternalException(java.lang.String mes)

Constructor

Parameters:

mes - Specifies Error Message.

 

HozoModelObject


public abstract class HozoModelObject

extends HozoObject

Hozo Model Object Class.

This class defines Model Object that Hozo uses.

 

Constructor Detail

HozoModelObject

public HozoModelObject(Model model)

Creates Hozo Model Object.

Parameters:

model - Affiliated Model

Method Detail

getModel

public Model getModel()

Gets the affiliated Model.

Returns:

Returns Model.


getReferenceOntology

public Ontology getReferenceOntology()

Gets Ontology to refer.

Returns:

Returns Ontology to refer.


setReferenceOntology

public void setReferenceOntology(Ontology ontology)

Sets Ontology to refer.

Parameters:

ontology - Sets Ontology to refer.


getOntologyObject

public HozoOntologyObject getOntologyObject()

Gets Ontology Object to refer.

Returns:

Returns Ontology Object to refer.


setOntologyObject

public void setOntologyObject(HozoOntologyObject ontologyObject)

Sets Ontology Object to refer.

Parameters:

ontologyObject - Sets Ontology Object to refer.


removeInstanceOfRelation

protected void removeInstanceOfRelation()

Deletes Instance Relation.


getGraphicObject

public GraphicObject getGraphicObject()

Gets Graphic Object.

Returns:

Returns Graphic Object.


setGraphicObject

public void setGraphicObject(GraphicObject gobj)

Sets Graphic Object.

Parameters:

gobj - Specifies Graphic Object.


createGraphicObject

public GraphicObject createGraphicObject()

Creates Graphic Object.

Returns:

Returns Graphic Object created.

 

HozoObject


public abstract class HozoObject

extends java.lang.Object

Hozo Object.

This class defines the Object that Hozo uses.

 

Constructor Detail

HozoObject

public HozoObject()

Creates Hozo Object. (Constructor)

Method Detail

getId

public java.lang.String getId()

Gets Hozo Object ID.

Returns:

Returns Hozo Object ID.


getObjectId

public java.lang.String getObjectId()

Gets Hozo Object ID

Returns:

Returns Hozo Object ID


getLabel

public java.lang.String getLabel()

Gets Hozo Object Label.

Returns:

Returns Hozo Object Label.


getDescription

public java.lang.String getDescription()

Gets Hozo Object.

Returns:

Returns Hozo Object Description (string).


setId

public void setId(java.lang.String id)

Sets Hozo Object ID.

Parameters:

id - Sets Hozo Object ID.


setObjectId

public void setObjectId(java.lang.String oid)

Sets Hozo Object ID.

Parameters:

oid - Sets Hozo Object ID.


setLabel

public void setLabel(java.lang.String label)

Sets Hozo Object Label.

Parameters:

label - Sets Hozo Object Label.


setDescription

public void setDescription(java.lang.String desc)

Sets Hozo Object Description.

Parameters:

desc - Sets Hozo Object Description.


getIndex

public int getIndex()

Gets Hozo Object Index.

Returns:

Returns Hozo Object Index.


setIndex

public void setIndex(int index)

Sets Hozo Object Index.

Parameters:

index - Sets Hozo Object Index.

 

HozoOntologyObject


public abstract class HozoOntologyObject

extends HozoObject

Hozo Ontology Object.

This class defines Hozon Ontology Object.

 

Constructor Detail

HozoOntologyObject

public HozoOntologyObject(Ontology ont)

Creates Hozo Ontology Object.

Parameters:

ont - Affiliated Ontology

Method Detail

getOntology

public Ontology getOntology()

Gets affiliated Ontology.

Returns:

Returns Ontology.


setOntology

public void setOntology(Ontology ont)

Sets affiliated Ontology.

Parameters:

ont - Sets affiliated Ontology.


getAxiom

public Axiom getAxiom()

Gets Axiom.

Returns:

Return Axiom.


setAxiom

public void setAxiom(Axiom axiom)

Sets Axiom.

Parameters:

axiom - Sets Axiom.


hasAxiom

public boolean hasAxiom()

Gets the boolean if Axiom is set.

Returns:

Returns the boolean if Axiom is set.


getGraphicObject

public GraphicObject getGraphicObject()

Gets Graphic Object.

Returns:

Returns Graphic Object.


setGraphicObject

public void setGraphicObject(GraphicObject gobj)

Sets Graphic Object.

Parameters:

gobj - Specifies Graphic Object.


createGraphicObject

public GraphicObject createGraphicObject()

Creates Graphic Object.

Returns:

Returns Graphic Object created.


getReferenceOntology

public Ontology getReferenceOntology()

Gets Reference Ontology.

Returns:

Returns Reference Ontology


setReferenceOntology

public void setReferenceOntology(Ontology ontology)

Sets Reference Ontology.

Parameters:

ontology - Specifies Reference Ontology


isReferenceOntologyObject

public boolean isReferenceOntologyObject()

Gets the boolean if it is Reference Ontology Object.

Returns:

Returns the boolean if it is Reference Ontology Object.

 

HZBasicConcept


public class HZBasicConcept

extends BasicConcept

Basic Concept Usage Class.

This class defines Basic Concept Usage.

 

Constructor Detail

HZBasicConcept

public HZBasicConcept(Ontology ont)

Creates Basic Concept. (Constructor)

Parameters:

ont - Specifies affiliated Ontology.

 

 

HZBasicConceptInstance


public class HZBasicConceptInstance

extends BasicConceptInstance

implements ConceptInstanceModel

Basic Concept Instance Usage Class.

This class defines Basic Concept Instance Usage.

 

Constructor Detail

HZBasicConceptInstance

public HZBasicConceptInstance(Model model)

Creates Basic Concept Instance. (Constructor)

Parameters:

model - Specifies Model.

Method Detail

createSlotInstance

public SlotInstance createSlotInstance(Slot slot,

                                       ConceptInstance constConIns)

Specifies Slot Instance.

Specified by:

createSlotInstance in interface ConceptInstanceModel

Parameters:

slot - Specifies the target Slot.

constConIns - Specifies the constraint Concept Instance.

Returns:

Returns Slot Instance created.

 

HZFileUtility


public class HZFileUtility
extends java.lang.Object

Extended File Processing Utility Class.

This class defines the file I/O process.
 

Author:

M. Ohta




Method Detail

isFileExists

public static boolean isFileExists(java.lang.String pathname)

Gets the boolean if the file exists.

Parameters:

pathname - Specifies the file path or URI (URL).

Returns:

Returns the boolean if the file exists.


isFileExisted

public static boolean isFileExisted(java.io.File[] files,
                                    java.io.File file)

Gets the boolean if the file exists in the list.

Parameters:

files - Specifies the file list.

file - Specifies the target file.

Returns:

Returns the boolean if the Ontology file exists.


isURI

protected static boolean isURI(java.lang.String uri)

Gets the boolean if it is URI.

Parameters:

uri - Specifies URI (URL).

Returns:

Returns the boolean if it is URI.


isFile

protected static boolean isFile(java.lang.String filename)

Gets the boolean if it is a file name.

Parameters:

filename - Specifies the file name.

Returns:

Returns the boolean if it is a file name.


getFileName

public static java.lang.String getFileName(java.lang.String filepath)

Gets File Name.

Parameters:

filepath - Specifies the file path

Returns:

Returns File Name.


getFilePath

public static java.lang.String getFilePath(java.lang.String pathname)

Gets File Path.

Parameters:

pathname - Specifies the file path name or URI (URL).

Returns:

Returns File Path.


escapeXML

protected static java.lang.String escapeXML(java.lang.String str)

Replaces Escape XML Character.

Parameters:

str - Specifies the string to save in the XML file.

Returns:

Returns the replaced string.


isTabooFileName

public static boolean isTabooFileName(java.lang.String str)

Determines if an illegal character is used in the file name (URL).

Parameters:

str - Specifies the string to set as the file name.

Returns:

Returns the boolean if an illegal character is used.


isTabooFileName

public static boolean isTabooFileName(java.lang.String str,
                                      java.lang.String strExtraChar)

Determines if an illegal character is used in the file name.

Parameters:

str - Specifies the string to set as the file name.

strExtraChar - Specifies additional illegal character.

Returns:

Returns the boolean if an illegal character is used.


makeBackupFile

public static boolean makeBackupFile(java.io.File saveFile,
                                     java.lang.String backupPath)

Creates Backup File.

Parameters:

saveFile - Specifies the file to make a backup.

backupPath - Specifies the directory of the backup file.

Returns:

Returns the boolean if Backup File was created.


getTimestamp

public static java.sql.Timestamp getTimestamp(java.lang.String strTime)

Converts the string to time.

Parameters:

strTime - Specifies the time string.


getDateString

public static java.lang.String getDateString(java.lang.String strTimestamp)

Converts Long Timestamp to a string.

Returns:

Returns the string that was converted from Long Timestamp.


copyFile

public static boolean copyFile(java.io.File file1,
                               java.io.File file2)

Copies File.

Parameters:

file 1 - Specifies the source file.

file 2 - Specifies the target file.


getOntologyNameFromPath

public static java.lang.String getOntologyNameFromPath(java.lang.String path)

GetsOntoloty Name from the file path.

Parameters:

path - Specifies the file path.

Returns:

Returns Ontology Name.


getOntologyNameFromPath

public static java.lang.String getOntologyNameFromPath(java.lang.String pathname,
                                                       boolean hasExtension)

Gets Ontology Name from the file path.

Parameters:

pathname - Specifies the file path name or URI (URL).

hasExtension - Specifies if the file path should include the extension.

Returns:

Returns Ontology Name.


getProjectNameFromPath

public static java.lang.String getProjectNameFromPath(java.lang.String path)

Gets Project Name from the file path.

Parameters:

path - Specifies the file path.

Returns:

Returns Project Name.


getFileData

public static java.lang.String getFileData(java.lang.String path)

Gets File Data in String.

Parameters:

path - Specifies the file path.

Returns:

Returns File Data.


getOntologyFileInfo

public static OntologyFileInfo getOntologyFileInfo(java.lang.String fileName)

Gets Ontology File Info from Ontology Name.

Parameters:

fileName - Specifies the file name.

Returns:

Returns Ontology File Info.


HZGraphicManager


public class HZGraphicManager
extends GraphicManager

Extended Graphic Data Management Class.

奼挘斉偺昤夋忣曬娗棟Class

 Defines Graphic Object.

 

Method Detail

setAllGraphicObjectsSelceted

public void setAllGraphicObjectsSelceted(boolean isSelected)

Specifies that all Graphic Objects have been selected.

Parameters:

isSelected - Specifies that Graphic Objects have been selected.


getSelcetedGraphicObjects

public java.util.List getSelcetedGraphicObjects()

Gets selected Graphic Objects.

Returns:

Returns the list of selected Graphic Objects.


hasSelcetedGraphicObjects

public boolean hasSelcetedGraphicObjects()

Returns the boolean if there are selected Graphic Objects.

Returns:

Returns the truth value if there are selected Graphic Objects.


getEndPoint

public java.awt.Point getEndPoint()

Gets End Point.

Returns:

Returns End Point


HZGraphicObject


public class HZGraphicObject
extends GraphicObject

Extended Graphic Object Class.

Maintains Graphic Data of Hozo Object.

 

Author:

ohta




Constructor Detail

HZGraphicObject

public HZGraphicObject()

Creates Graphic Object. (Constructor)


HZGraphicObject

public HZGraphicObject(double dx,
                       double dy)

Creates Graphic Object. (Constructor)

Parameters:

dx - Specifies X-coordinate.

dy - Specifies Y-coordinate.

Method Detail

setSize

public void setSize(double dx,
                    double dy,
                    double dw,
                    double dh)

Specifies Size.

Parameters:

dx - Specifies X-coordinate of Size (double).

dy - Specifies Y-coordinate of Size (double).

dw - Specifies the width of Size (double)

dh - Specifies the height of Size (double).


setPosition

public void setPosition(java.awt.Point p)

Specifies Position.

Parameters:

p - Specifies Position (Point Class).


isSelected

public boolean isSelected()

Specifies if Graphic Object has been selected.

Returns:

Returns the boolean if Graphic Object has been selected.


setSelected

public void setSelected(boolean isSelected)

Sets Graphic Object being selected.

Parameters:

isSelected - Specifies Graphic Object being selected.


isOpened

public boolean isOpened()

Gets the boolean if Graphic Object has been opened.

Returns:

Returns the boolean if Graphic Object has been opened.


setOpened

public void setOpened(boolean isOpened)

Sets Graphic Object being opened.

Parameters:

isOpened - Specifies Graphic Object being opened.


isMouseEntered

public boolean isMouseEntered()

Gets the boolean if there is a mouse pointer on Graphic Object.

Returns:

Returns the boolean if there is a mouth pointer on Graphic Object.


setMouseEntered

public void setMouseEntered(boolean isMouseEntered)

Sets the mouse pointer so it is on Graphic Object.

Parameters:

isMouseEntered - Specifies the mouse pointer so it is on Graphic Object.


getCurBoundsWidth

public int getCurBoundsWidth()

Gets Width of the area where Graphic Object is drawn.

Returns:

Returns Width of the area where Graphic Object is drawn.


getCurBoundsHeight

public int getCurBoundsHeight()

Gets Height of the area where Graphic Object is drawn.

Returns:

Returns Height of the area where Graphic Object is drawn.


getEndPoint

public java.awt.Point getEndPoint()

Gets End Point of the area where Graphic Object is drawn.

Returns:

Returns End Point of the area where Graphic Object is drawn.


 

HZModel


public class HZModel
extends Model

Instance Model Usage Class.

 This class defines Instance Model Usage.
 

Author:

ohta




Constructor Detail

HZModel

public HZModel()

Creates Model. (Constructor)

Method Detail

load

public void load()

Loads Model.

Loads the Model data from the file specified by the setSource (String) method of this class.
 

Overrides:

load in class Model


load

public void load(int paser)

Loads Model.

Loads the Model data from the file specified by the setSource (String) method of this class.
 

Overrides:

load in class Model

Parameters:

paser[TK1]  - Specifies the parser.


load

public void load(int paser,
                 int mode)

Loads Model.

儌僨儖偺撉崬傪峴偄傑偡丅

Loads the Model data from the file specified by the setSource (String) method of this class.
 

Parameters:

paser[TK2]  - Specifies the parser.

mode - Specifies the mode to load the data.


save

public void save()

Saves Model.

Overwrites and saves the Model data in the file specified by the setSource (String) method of this class.
 

Overrides:

save in class Model


save

public void save(java.lang.String encoding)

Specifies the character encoding and saves Model.

Overwrites and saves the Model data in the file specified by the setSource (String) method of this class.
 If character encoding is not specified, the data is saved in the default character encoding.
 

Overrides:

save in class Model

Parameters:

encoding - Sets the character encoding.


initModel

public void initModel()

Initializes Model

Overrides:

initModel in class Model


reentryHozoModelObject

public void reentryHozoModelObject(HozoModelObject hmObj)

Re-enters Model Object.

Parameters:

hmObj - Specifies Model Object.


getSelectedModelObjectList

public java.util.List getSelectedModelObjectList()

Returns Selected Model Object List.

Returns:

Returns Selected Model Object List.


addHozoModelObject

public void addHozoModelObject(HozoModelObject hmObj)

Adds Model Object.

  Identifies Model Object and executes the Add method in Model Class.
 

Parameters:

hmObj - Specifies Model Object.


removeHozoModelObject

public void removeHozoModelObject(HozoModelObject hmObj)

Deletes Model Object.

  Identifies Model Object and executes the Delete method in Model Class.
 

Parameters:

hmObj - Specifies Model Object.


addConceptInstance

public void addConceptInstance(ConceptInstance conceptInstance)

Adds Concept Instance to Model. (Override)

Overrides:

addConceptInstance in class Model

Parameters:

conceptInstance - Sets Concept Instance to add.


addSlotInstance

public void addSlotInstance(SlotInstance slotInstance)

Adds Slot Instance to Model. (Override)

Overrides:

addSlotInstance in class Model

Parameters:

slotInstance - Sets Slot Instance to add.


addRelationInstance

public void addRelationInstance(RelationInstance relationInstance)

Adds Relation Concept Instance to Model. (Override)

Overrides:

addRelationInstance in class Model

Parameters:

relationInstance - Sets Relation Concept Instance to add.


removeConceptInstance

public void removeConceptInstance(ConceptInstance conceptInstance)

Deletes Concept Instance from Model. (Override)

Overrides:

removeConceptInstance in class Model

Parameters:

conceptInstance - Specifies Concept Instance to delete.


removeSlotInstance

public void removeSlotInstance(SlotInstance slotInstance)

Deletes Slot Instance from Model. (Override)

Overrides:

removeSlotInstance in class Model

Parameters:

slotInstance - Specifies Slot Instance to delete.


removeRelationInstance

public void removeRelationInstance(RelationInstance relationInstance)

Deletes Relation Concept Instance from Model. (Override)

Overrides:

removeRelationInstance in class Model

Parameters:

relationInstance - Specifies Relation Concept Instance to delete.


addReferenceOntology

public void addReferenceOntology(Ontology ontology)

Adds Reference Ontology to Model. (Override)

Overrides:

addReferenceOntology in class Model

Parameters:

ontology - Sets Reference Ontology to add.


removeReferenceOntology

public void removeReferenceOntology(Ontology ontology)

Deletes Reference Ontology from Model. (Override)

Overrides:

removeReferenceOntology in class Model

Parameters:

ontology - Sets Reference Ontology to delete.


checkConstraintValue

public boolean checkConstraintValue(SlotInstance slotIns,
                                    ConceptInstance conIns)

Checks if Constraint Value is correct.

Parameters:

slotIns - Specifies the target Slot Instance.

conIns - Specifies Concept Instance that becomes Constraint Value.

Returns:

Returns the boolean if Constraint Value is correct.


getUnplayedRoleConcept

public RoleConcept getUnplayedRoleConcept(ConceptInstance conIns,
                                          RoleHolder roleHolder)

Returns the boolean if Concept Instance satisfies Role.

This method was added on 09/15/2006.
 Note: Since this is a temporary specification, refactoring is required.
 

Parameters:

conIns - Specifies Concept Instance.

roleHolder - Specifies the target Role Holder.

Returns:

Returns Role that Concept Instance does not satisfy.


createConceptInstance

public ConceptInstance createConceptInstance(int type,
                                             java.lang.String label,
                                             java.lang.String description,
                                             Concept concept)

Creates Concept Instance.

Concept Instance type can be specified for only the following Concept Class.
Basic ConceptInstance:
 丂丂"1" (=BasicConceptInstance.INSTANCE_TYPE)
 Role ConceptInstanceRoleConceptInstance
 丂丂"4" (=RoleConceptInstance.INSTANCE_TYPE)
 

Parameters:

type - Specifies the Concept Instance type.

label - Specifies the Concept label

description - Specifies the Concept description.

concept - Specifies Reference Concept.

Returns:

Returns Concept Instance created.


createBasicConceptInstance

public ConceptInstance createBasicConceptInstance(java.lang.String label,
                                                  java.lang.String description,
                                                  Concept concept)

Creates Basic Concept Instance Class.

Parameters:

label - Specifies the Concept Class label.

description - Specifies the Concept description.

concept - Specifies Reference Concept.

Returns:

Returns Concept Instance created.


createRoleConceptInstance

public ConceptInstance createRoleConceptInstance(java.lang.String label,
                                                 java.lang.String description,
                                                 Concept concept)

Creates Basic Concept Instance Class.

Parameters:

label - Specifies the Concept Class label.

description - Specifies the Concept description.

concept - Specifies Reference Concept.

Returns:

Returns Concept Instance created.


isLoaded

public boolean isLoaded()

Gets the boolean if the source file has been loaded.

Returns:

Returns the boolean if the source file has been loaded.


setLoaded

public void setLoaded(boolean isLoaded)

Sets the boolean if the source file is loaded.

Parameters:

isLoaded - Specifies the source file being loaded.


 

HZModelUtility


public class HZModelUtility
extends java.lang.Object

Extended Model Process Utility Class.

This class defines the model I/O process.
 Note that this class is separated from Hozo Core Utility Class.

 

Author:

M. Ohta


 

Method Detail

isModelFile

public static boolean isModelFile(java.lang.String fileName)
                           throws java.lang.Exception

Determines if the XML file is model data.

Parameters:

fileName - Ontology XML file name.

Returns:

Returns the boolen if it is the model.

Throws:

java.lang.Exception


loadModelData

public void loadModelData(Model model)
                   throws java.lang.Exception

Loads XML Model Data.

  
 Note) If the Ontology file name is URL or if the file resides in the same location as the model file, the Ontology file is loaded.
 

Parameters:

model - Specifies Model.

Throws:

java.lang.Exception


saveModelData

public void saveModelData(Model model)
                   throws java.lang.Exception

Saves XML Model Data.

Parameters:

model - Specifies Model.

Throws:

java.lang.Exception


getEncoding

public java.lang.String getEncoding()

Gets Encoding to save the model data.

Returns:

Returns Enconding.


setEncoding

public void setEncoding(java.lang.String encoding)

Sets Encoding to save the model data.

Parameters:

encoding - Sets Enconding.


getSaveMode

public int getSaveMode()

Gets Save Mode.

Returns:

Returns Save Mode.


setSaveMode

public void setSaveMode(int mode)

Sets Save Mode.

Parameters:

mode - Specifies Save Mode.


getLoadMode

public int getLoadMode()

Gets Load Mode.

Returns:

Returns Load Mode.


setLoadMode

public void setLoadMode(int mode)

Sets Load Mode.

Parameters:

mode - Specifies Load Mode.


 

HZModelUtilitySax


public class HZModelUtilitySax
extends java.lang.Object

Extended Model Process Utility Class.

This class defines the model I/O process.
 Note that this class is separated from Hozo Core Utility Class.
 

Author:

M. Ohta


 

Method Detail

isModelFile

public static boolean isModelFile(java.lang.String fileName)
                           throws java.lang.Exception

Determines if the XML file is the model data.

Parameters:

fileName - Ontology XML file name.

Returns:

Returns the boolean if it is the model.

Throws:

java.lang.Exception


loadModelData

public void loadModelData(Model model)
                   throws java.lang.Exception

Loads XML Model Data.

  
 Note) If the Ontology file name is URL or if the file resides in the same location as the model file, the Ontology file is loaded.
 

Parameters:

model - Specifies Model.

Throws:

java.lang.Exception


saveModelData

public void saveModelData(Model model)
                   throws java.lang.Exception

Saves XML Model Data.

Parameters:

model - Specifies Model.

Throws:

java.lang.Exception


getEncoding

public java.lang.String getEncoding()

Gets Encoding to save the model data.

Returns:

Returns Encoding.


setEncoding

public void setEncoding(java.lang.String encoding)

Sets Encoding to save the model data.

Parameters:

encoding - Sets Encoding.


getSaveMode

public int getSaveMode()

Gets Save Mode.

Returns:

Returns Save Mode.


setSaveMode

public void setSaveMode(int mode)

Sets Save Mode.

Parameters:

mode - Specifies Save Mode.


getLoadMode

public int getLoadMode()

Gets Load Mode.

Returns:

Returns Load Mode.


setLoadMode

public void setLoadMode(int mode)

Sets Load Mode.

Parameters:

mode - Specifies Load Mode.

HZOntology


public class HZOntology
extends Ontology

Ontology Usage Class.

 This class defines Ontology Usage.

 

 

Method Detail

initOntology

public void initOntology()

Initialization

Overrides:

initOntology in class Ontology


load

public void load()

Loads Ontology.

 Loads the Ontology data from the file specified by the method setSource (String) in this class.
 

Overrides:

load in class Ontology


load

public void load(int paser)

Loads Ontology.

Loads the Ontology data from the file specified by the method setSource (String) in this class.
 

Overrides:

load in class Ontology

Parameters:

paser - Specifies the parser.


load

public void load(java.io.InputStream is,
                 int paser)

Loads Ontology.

Loads the Ontology data from the specified input stream.
 

Overrides:

load in class Ontology

Parameters:

is - Specifies the input stream.

paser[TK3]  - Specifies the parser.


loadProperties

public void loadProperties()

Loads only property data of Ontology.

Loads the Ontology data is from the file specified by the method setSource (String) in this class.

 

loadProperties

public void loadProperties(int paser)

Loads only property data of Ontology.

Loads the Ontology data from the file specified by the method setSource (String) in this class.
 

Parameters:

paser[TK4]