CaCORE::EVS

- Association

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of Association
- ASSOCIATIONS of Association

- Atom

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of Atom
- ASSOCIATIONS of Atom

- AttributeSetDescriptor

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of AttributeSetDescriptor
- ASSOCIATIONS of AttributeSetDescriptor

- Definition

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of Definition
- ASSOCIATIONS of Definition

- DescLogicConcept

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of DescLogicConcept
- ASSOCIATIONS of DescLogicConcept

- EdgeProperties

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of EdgeProperties
- ASSOCIATIONS of EdgeProperties

- EditActionDate

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of EditActionDate
- ASSOCIATIONS of EditActionDate

- HashSet

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of HashSet
- ASSOCIATIONS of HashSet

- History

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of History
- ASSOCIATIONS of History

- HistoryRecord

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of HistoryRecord
- ASSOCIATIONS of HistoryRecord

- MetaThesaurusConcept

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of MetaThesaurusConcept
- ASSOCIATIONS of MetaThesaurusConcept

- Property

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of Property
- ASSOCIATIONS of Property

- Qualifier

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of Qualifier
- ASSOCIATIONS of Qualifier

- Role

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of Role
- ASSOCIATIONS of Role

- SemanticType

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of SemanticType
- ASSOCIATIONS of SemanticType

- Silo

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of Silo
- ASSOCIATIONS of Silo

- Source

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of Source
- ASSOCIATIONS of Source

- TreeNode

- ABSTRACT
- SYNOPSIS
- DESCRIPTION
- ATTRIBUTES of TreeNode
- ASSOCIATIONS of TreeNode

- SUPPORT
- AUTHOR
- COPYRIGHT AND LICENSE

# Association

CaCORE::EVS::Association - Perl extension for Association.

## ABSTRACT

The CaCORE::EVS::Association is a Perl object representation of the CaCORE Association object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

An Association class relates a concept or a term to another concept or term. Association falls into 3 categories; concept association, term association and synonyms which are concept-term associations.

## ATTRIBUTES of Association

The following are all the attributes of the Association object and their data types:

name

  data type: `string`

value

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of Association

The following are all the objects that are associated with the Association:

Instance of Qualifier:

  One to many assoication, use `getQualifierCollection` to get a collection of associated Qualifier.

# Atom

CaCORE::EVS::Atom - Perl extension for Atom.

## ABSTRACT

The CaCORE::EVS::Atom is a Perl object representation of the CaCORE Atom object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

Atom is an occurence of a term in a source.

## ATTRIBUTES of Atom

The following are all the attributes of the Atom object and their data types:

code

  data type: `string`

lui

  data type: `string`

name

  data type: `string`

origin

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of Atom

The following are all the objects that are associated with the Atom:

Collection of Source:

  Many to one assoication, use `getSource` to get the associated Source.

# AttributeSetDescriptor

CaCORE::EVS::AttributeSetDescriptor - Perl extension for AttributeSetDescriptor.

## ABSTRACT

The CaCORE::EVS::AttributeSetDescriptor is a Perl object representation of the CaCORE AttributeSetDescriptor object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

AttributeSetDescriptor class specifies the set of concept attributes that should be retrieved by a given operation.

## ATTRIBUTES of AttributeSetDescriptor

The following are all the attributes of the AttributeSetDescriptor object and their data types:

name

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of AttributeSetDescriptor

The following are all the objects that are associated with the AttributeSetDescriptor:

Instance of Property:

  One to many assoication, use `getPropertyCollection` to get a collection of associated Property.

Instance of Role:

  One to many assoication, use `getRoleCollection` to get a collection of associated Role.

# Definition

CaCORE::EVS::Definition - Perl extension for Definition.

## ABSTRACT

The CaCORE::EVS::Definition is a Perl object representation of the CaCORE Definition object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

Textual definition from an identified source

## ATTRIBUTES of Definition

The following are all the attributes of the Definition object and their data types:

definition

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of Definition

The following are all the objects that are associated with the Definition:

Collection of Source:

  Many to one assoication, use `getSource` to get the associated Source.

# DescLogicConcept

CaCORE::EVS::DescLogicConcept - Perl extension for DescLogicConcept.

## ABSTRACT

The CaCORE::EVS::DescLogicConcept is a Perl object representation of the CaCORE DescLogicConcept object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

The DescLogicConcept class represents the fundermental vocabulary entity in the NCI Thesaurus.

## ATTRIBUTES of DescLogicConcept

The following are all the attributes of the DescLogicConcept object and their data types:

code

  data type: `string`

hasChildren

  data type: `boolean`

hasParents

  data type: `boolean`

isRetired

  data type: `boolean`

name

  data type: `string`

namespaceId

  data type: `int`

vocabularyName

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of DescLogicConcept

The following are all the objects that are associated with the DescLogicConcept:

Instance of Association:

  One to many assoication, use `getAssociationCollection` to get a collection of associated Association.

Collection of EdgeProperties:

  Many to one assoication, use `getEdgeProperties` to get the associated EdgeProperties.

Instance of InverseAssociation:

  One to many assoication, use `getInverseAssociationCollection` to get a collection of associated InverseAssociation.

Instance of InverseRole:

  One to many assoication, use `getInverseRoleCollection` to get a collection of associated InverseRole.

Instance of Property:

  One to many assoication, use `getPropertyCollection` to get a collection of associated Property.

Instance of Role:

  One to many assoication, use `getRoleCollection` to get a collection of associated Role.

Instance of SemanticTypeVector:

  One to many assoication, use `getSemanticTypeVectorCollection` to get a collection of associated SemanticTypeVector.

Collection of TreeNode:

  Many to one assoication, use `getTreeNode` to get the associated TreeNode.

# EdgeProperties

CaCORE::EVS::EdgeProperties - Perl extension for EdgeProperties.

## ABSTRACT

The CaCORE::EVS::EdgeProperties is a Perl object representation of the CaCORE EdgeProperties object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

The EdgeProperties class specifies the relationshop between a concept and it's immediate parent when a TREE is generated using the getTree method.

## ATTRIBUTES of EdgeProperties

The following are all the attributes of the EdgeProperties object and their data types:

isA

  data type: `boolean`

name

  data type: `string`

traverseDown

  data type: `boolean`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of EdgeProperties

The following are all the objects that are associated with the EdgeProperties:

Instance of Links:

  One to many assoication, use `getLinksCollection` to get a collection of associated Links.

# EditActionDate

CaCORE::EVS::EditActionDate - Perl extension for EditActionDate.

## ABSTRACT

The CaCORE::EVS::EditActionDate is a Perl object representation of the CaCORE EditActionDate object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

GenericDescription

## ATTRIBUTES of EditActionDate

The following are all the attributes of the EditActionDate object and their data types:

action

  data type: `int`

editDate

  data type: `dateTime`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of EditActionDate

The following are all the objects that are associated with the EditActionDate:

# HashSet

CaCORE::EVS::HashSet - Perl extension for HashSet.

## ABSTRACT

The CaCORE::EVS::HashSet is a Perl object representation of the CaCORE HashSet object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

GenericDescription

## ATTRIBUTES of HashSet

The following are all the attributes of the HashSet object and their data types:

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of HashSet

The following are all the objects that are associated with the HashSet:

# History

CaCORE::EVS::History - Perl extension for History.

## ABSTRACT

The CaCORE::EVS::History is a Perl object representation of the CaCORE History object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

The History class stores the concept history information.

## ATTRIBUTES of History

The following are all the attributes of the History object and their data types:

editAction

  data type: `string`

editActionDate

  data type: `dateTime`

namespaceId

  data type: `int`

referenceCode

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of History

The following are all the objects that are associated with the History:

# HistoryRecord

CaCORE::EVS::HistoryRecord - Perl extension for HistoryRecord.

## ABSTRACT

The CaCORE::EVS::HistoryRecord is a Perl object representation of the CaCORE HistoryRecord object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

The HistoryRecord holds history information for the specifed concept

## ATTRIBUTES of HistoryRecord

The following are all the attributes of the HistoryRecord object and their data types:

descLogicConceptCode

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of HistoryRecord

The following are all the objects that are associated with the HistoryRecord:

Instance of History:

  One to many assoication, use `getHistoryCollection` to get a collection of associated History.

# MetaThesaurusConcept

CaCORE::EVS::MetaThesaurusConcept - Perl extension for MetaThesaurusConcept.

## ABSTRACT

The CaCORE::EVS::MetaThesaurusConcept is a Perl object representation of the CaCORE MetaThesaurusConcept object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

MetaThesaurusConcept is the fundermental vocabulary entity in the NCI MetaThesaurus.

## ATTRIBUTES of MetaThesaurusConcept

The following are all the attributes of the MetaThesaurusConcept object and their data types:

cui

  data type: `string`

name

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of MetaThesaurusConcept

The following are all the objects that are associated with the MetaThesaurusConcept:

Instance of Atom:

  One to many assoication, use `getAtomCollection` to get a collection of associated Atom.

Instance of Definition:

  One to many assoication, use `getDefinitionCollection` to get a collection of associated Definition.

Instance of SemanticType:

  One to many assoication, use `getSemanticTypeCollection` to get a collection of associated SemanticType.

Instance of Source:

  One to many assoication, use `getSourceCollection` to get a collection of associated Source.

Instance of Synonym:

  One to many assoication, use `getSynonymCollection` to get a collection of associated Synonym.

# Property

CaCORE::EVS::Property - Perl extension for Property.

## ABSTRACT

The CaCORE::EVS::Property is a Perl object representation of the CaCORE Property object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

Property is an attribute of a concept. Examples of properties are ``Synonym'', ``Preferred_Name'', ``Semantic_Type'' etc.

## ATTRIBUTES of Property

The following are all the attributes of the Property object and their data types:

name

  data type: `string`

value

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of Property

The following are all the objects that are associated with the Property:

Instance of Qualifier:

  One to many assoication, use `getQualifierCollection` to get a collection of associated Qualifier.

# Qualifier

CaCORE::EVS::Qualifier - Perl extension for Qualifier.

## ABSTRACT

The CaCORE::EVS::Qualifier is a Perl object representation of the CaCORE Qualifier object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

A Qualifier is attached to associations and properties of a concept.

## ATTRIBUTES of Qualifier

The following are all the attributes of the Qualifier object and their data types:

name

  data type: `string`

value

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of Qualifier

The following are all the objects that are associated with the Qualifier:

# Role

CaCORE::EVS::Role - Perl extension for Role.

## ABSTRACT

The CaCORE::EVS::Role is a Perl object representation of the CaCORE Role object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

Defines a relationship between two concepts.

## ATTRIBUTES of Role

The following are all the attributes of the Role object and their data types:

name

  data type: `string`

value

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of Role

The following are all the objects that are associated with the Role:

# SemanticType

CaCORE::EVS::SemanticType - Perl extension for SemanticType.

## ABSTRACT

The CaCORE::EVS::SemanticType is a Perl object representation of the CaCORE SemanticType object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

Semantic type is a category defined in the semantic network that can be used to group similar concepts

## ATTRIBUTES of SemanticType

The following are all the attributes of the SemanticType object and their data types:

id

  data type: `string`

name

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of SemanticType

The following are all the objects that are associated with the SemanticType:

# Silo

CaCORE::EVS::Silo - Perl extension for Silo.

## ABSTRACT

The CaCORE::EVS::Silo is a Perl object representation of the CaCORE Silo object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

Silo is a repository of customized concept terminology data from a knowledgebase. There can be a single silo or multiple silos, each consisting of semantically related concepts and extracted character strings associated with those concepts.

## ATTRIBUTES of Silo

The following are all the attributes of the Silo object and their data types:

id

  data type: `int`

name

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of Silo

The following are all the objects that are associated with the Silo:

# Source

CaCORE::EVS::Source - Perl extension for Source.

## ABSTRACT

The CaCORE::EVS::Source is a Perl object representation of the CaCORE Source object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

The source is a knowledge base.

## ATTRIBUTES of Source

The following are all the attributes of the Source object and their data types:

abbreviation

  data type: `string`

description

  data type: `string`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of Source

The following are all the objects that are associated with the Source:

# TreeNode

CaCORE::EVS::TreeNode - Perl extension for TreeNode.

## ABSTRACT

The CaCORE::EVS::TreeNode is a Perl object representation of the CaCORE TreeNode object.

## SYNOPSIS

See the CaCORE::ApplicationService manpage.

## DESCRIPTION

The TreeNode class specifies the relationshop between a concept and it's immediate parent when a TREE is generated using the getTree method.

## ATTRIBUTES of TreeNode

The following are all the attributes of the TreeNode object and their data types:

isA

  data type: `boolean`

name

  data type: `string`

traverseDown

  data type: `boolean`

      Note: Although you can also use the corresponding setter methods to set the
      attribute values, it is not recommended to do so unless you absolutely have
      to change the object's attributes.

## ASSOCIATIONS of TreeNode

The following are all the objects that are associated with the TreeNode:

Instance of Links:

  One to many assoication, use `getLinksCollection` to get a collection of associated Links.

# SUPPORT

Please do not contact author directly. Send email to ncicb@pop.nci.nih.gov to request support or report a bug.

# AUTHOR

Shan Jiang <jiangs@mail.nih.gov>

# COPYRIGHT AND LICENSE

The CaCORE Software License, Version 1.0

      Copyright 2001-2005 SAIC. This software was developed in conjunction with the
      National Cancer Institute, and so to the extent government employees are co-authors,
      any rights in such works shall be subject to Title 17 of the United States Code,
      section 105. 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 disclaimer of Article 5, below. Redistributions in binary
         form must reproduce the above copyright notice, this list of conditions and the
         disclaimer of Article 5 in the documentation and/or other materials provided with
         the distribution.

      2. The end-user documentation included with the redistribution, if any, must include
         the following acknowledgment: "This product includes software developed by SAIC and
         the National Cancer Institute." If no such end-user documentation is to be included,
         this acknowledgment shall appear in the software itself, wherever such third-party
         acknowledgments normally appear.

      3. The names "The National Cancer Institute", "NCI" and "SAIC" must not be used to
         endorse or promote products derived from this software. This license does not
         authorize the licensee to use any trademarks owned by either NCI or SAIC.

      4. This license does not authorize or prohibit the incorporation of this software into
         any third party proprietary programs. Licensee is expressly made responsible for
         obtaining any permission required to incorporate this software into third party
         proprietary programs and for informing licensee's end-users of their obligation
         to secure any required permissions before incorporating this software into third
         party proprietary software programs.

      5. THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES, (INCLUDING,
         BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT AND
         FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO EVENT SHALL THE NATIONAL
         CANCER INSTITUTE, SAIC, OR THEIR AFFILIATES 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.