robokudo.types.core¶

Core type definitions for Robokudo.

This module provides the base type hierarchy for Robokudo’s type system. It is comparable to uima.cas.TOP in uimacpp and provides the foundation for all other types in the system.

The module defines:

Base Type class
Common type mixins (Identifiable, Nameable)
Query and Annotation types

Classes¶

`Type`	Base class for all Robokudo types.
`Identifiable`	Mixin class for types that need unique identification.
`Nameable`	Mixin class for types that need a name.
`Query`	Type representing a query in the system.
`Annotation`	Base class for all annotations.
`IdentifiableAnnotation`	Annotation type with unique identification.

Module Contents¶

class robokudo.types.core.Type¶

Base class for all Robokudo types.

This is the root of the type hierarchy, comparable to uima.cas.TOP in uimacpp. All other types in the system should inherit from this class.

class robokudo.types.core.Identifiable¶

Bases: Type

Mixin class for types that need unique identification.

Adds an ID field to types that need to be uniquely identified.

Variables:: id – Unique identifier string

id = ''¶

class robokudo.types.core.Nameable¶

Bases: Type

Mixin class for types that need a name.

Adds a name field to types that need to be named.

Variables:: name – Name of the instance

name = ''¶

class robokudo.types.core.Query¶

Bases: Type

Type representing a query in the system.

Encapsulates query information for processing.

Variables:: query – Query string to be processed

query = ''¶

class robokudo.types.core.Annotation¶

Bases: Type

Base class for all annotations.

Represents metadata or annotations added to data during processing.

Variables:: source – Source of the annotation

source = ''¶

class robokudo.types.core.IdentifiableAnnotation¶

Bases: Annotation, Identifiable

Annotation type with unique identification.

Combines annotation capabilities with unique identification. Inherits source from Annotation and id from Identifiable.

Variables:

source – Source of the annotation
id – Unique identifier string