lexicor 0.1.0

An optimized, strictly typed, offline interface for the Open English WordNet database.

Lexicor

Lexicor is a strictly typed, highly optimized, offline interface for the Open English WordNet.

It provides a high-performance, embedded SQL engine to query English definitions, synonyms, antonyms, hypernyms, and more, without relying on external APIs or raw text parsing.

✨ Features

• 🚀 Highly Optimized: Powered by a custom 7.8MB SQLite database (shrunk from ~25MB) using WITHOUT ROWID optimizations for maximum speed.
• 🔒 Strictly Typed: No magic strings or integers. Work with Concept, SpeechPart, RelationType, and DomainCategory objects.
• 🧠 Morphology Aware: Automatically handles stem resolution. Searching for "ran" matches "run"; "better" matches "good".
• ⚡ Dual Modes:
  • Disk Mode: Instant startup, low memory usage (ideal for Mobile/CLI).
  • Memory Mode: Loads DB into RAM for nanosecond-level query speeds (ideal for Servers).
• 🔗 Rich Relations: Distinguishes between Semantic relations (Concept-to-Concept) and Lexical relations (Word-to-Word).

📦 Installation

Add lexicor to your pubspec.yaml:

dependencies:
  lexicor: ^1.0.0

🚀 Quick Start

import 'package:lexicor/lexicor.dart';

void main() async {
  // 1. Initialize (Disk mode is default)
  final lexicor = await Lexicor.init();

  // 2. Lookup a word
  final result = lexicor.lookup('bank');
  
  print('Found ${result.length} concepts for "${result.query}"');

  // 3. Iterate concepts
  for (final concept in result) {
    print('[${concept.pos.label}] ${concept.domain.label}');
    
    // 4. Get relationships (Hypernyms, Parts, Antonyms...)
    final relations = lexicor.related(concept);
    
    for (final rel in relations.withRelation(RelationType.hypernym)) {
      print('  -> is a type of: ${rel.word}');
    }
  }

  // 5. Cleanup
  lexicor.close();
}

📖 Usage Guide

Initialization Modes

Lexicor offers two ways to load the database via StorageMode:

// 1. OnDisk (Default)
// Instant startup (~10ms). Good for CLI tools and Flutter apps.
final db = await Lexicor.init(mode: StorageMode.onDisk);

// 2. InMemory
// Slower startup (~50ms) but faster queries. Good for backend servers/analysis.
final db = await Lexicor.init(mode: StorageMode.inMemory);

Flutter Integration

Because Flutter assets are packed into the app bundle, sqlite3 cannot open them directly. You must copy the asset to a file path first (e.g., using path_provider).

// In Flutter, copy the asset to ApplicationDocumentsDirectory first, then:
final lexicor = await Lexicor.init(
  customPath: '/path/to/app_documents/dictionary.sqlite',
);

Morphology

Lexicor automatically resolves word forms. You don't need to manually stem words.

// The user types "running"
final result = lexicor.lookup('running');

// Lexicor automatically searches for "run"
print(result.resolvedForms); // ['running', 'run']

If you need raw access to morphology:

final root = lexicor.morphology('better', SpeechPart.adjective);
print(root); // "good"

Relationships

WordNet distinguishes between two types of links:

1. Semantic (Concept-to-Concept): e.g., A Dog is an Animal.
2. Lexical (Word-to-Word): e.g., Slow is the antonym of Fast.

lexicor.related() returns both, but you can filter them:

final rels = lexicor.related(concept);

// Get synonyms, hypernyms, etc.
final semantic = rels.semanticOnly;

// Get antonyms, derivations, etc.
final lexical = rels.lexicalOnly;

// Filter by specific type
final parts = rels.byType(RelationType.partMeronym);

📂 Database & License

This package includes a compressed, optimized version of the Open English WordNet 2022.

• Database License: CC BY 4.0 (Open English WordNet).
• Package License: MIT.

Using this package in your commercial app requires you to attribute the Open English WordNet project in your app's About/License section.