The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

RDF::Cowl::Lib::Gen::Class::Manager - Generated docs for RDF::Cowl::Manager

VERSION

version 1.0.0

MAIN MODULE

RDF::Cowl::Manager

CONSTRUCTORS

new

Signature:

  RDF::Cowl::Manager->new()

Documentation:

  Returns a retained manager that uses the default reader and writer.
  
  @return Retained manager. Throws exception on error.
  
  @note You can specify the default reader and writer
        via `cowl_set_reader()` and `cowl_set_writer()`.

Throws exception on error.

    C function name: cowl_manager

METHODS

set_reader

Signature:

  $self->set_reader(CowlReader $reader)

Params:

  CowlManager $manager 
  CowlReader $reader 

Documentation:

  Sets the reader.
  
  @param manager The manager.
  @param reader The reader.

    C function name: cowl_manager_set_reader

set_writer

Signature:

  $self->set_writer(CowlWriter $writer)

Params:

  CowlManager $manager 
  CowlWriter $writer 

Documentation:

  Sets the writer.
  
  @param manager The manager.
  @param writer The writer.

    C function name: cowl_manager_set_writer

set_import_loader

Signature:

  $self->set_import_loader(CowlImportLoader $loader)

Params:

  CowlManager $manager 
  CowlImportLoader $loader 

Documentation:

  Sets the import loader.
  
  @param manager The manager.
  @param loader The import loader.

    C function name: cowl_manager_set_import_loader

set_error_handler

Signature:

  $self->set_error_handler(CowlErrorHandler $handler)

Params:

  CowlManager $manager 
  CowlErrorHandler $handler 

Documentation:

  Sets the error handler.
  
  @param manager The manager.
  @param handler The error handler.

    C function name: cowl_manager_set_error_handler

get_ontology

Signature:

  $self->get_ontology(CowlOntologyId $id)

Params:

  CowlManager $manager 
  CowlOntologyId $id 

Documentation:

  Gets the ontology with the specified identifier.
  If no existing ontology has the specified identifier, a new ontology is returned.
  
  @param manager The manager.
  @param id The ontology identifier.
  @return Ontology with the specified identifier.

    C function name: cowl_manager_get_ontology

read_path

Signature:

  $self->read_path(UString $path)

Params:

  CowlManager $manager 
  UString $path 

Documentation:

  Reads an ontology from the file at the specified path.
  
  @param manager The manager.
  @param path The file path.
  @return The read ontology. Throws exception on error.

Throws exception on error.

    C function name: cowl_manager_read_path

read_string

Signature:

  $self->read_string(UString $string)

Params:

  CowlManager $manager 
  UString $string 

Documentation:

  Reads an ontology from the specified string.
  
  @param manager The manager.
  @param string The input string.
  @return The read ontology. Throws exception on error.

Throws exception on error.

    C function name: cowl_manager_read_string

read_stream

Signature:

  $self->read_stream(UIStream $stream)

Params:

  CowlManager $manager 
  UIStream $stream 

Documentation:

  Reads an ontology from the specified input stream.
  
  @param manager The manager.
  @param stream The input stream.
  @return The read ontology. Throws exception on error.
  
  @note The stream is not released by the manager, you must do it yourself.

Throws exception on error.

    C function name: cowl_manager_read_stream

write_path

Signature:

  $self->write_path(CowlOntology $ontology, UString $path)

Params:

  CowlManager $manager 
  CowlOntology $ontology 
  UString $path 

Documentation:

  Writes the ontology to the file at the specified path.
  
  @param manager The manager.
  @param ontology The ontology.
  @param path The file path.
  @return Return code.

    C function name: cowl_manager_write_path

write_strbuf

Signature:

  $self->write_strbuf(CowlOntology $ontology, UStrBuf $buf)

Params:

  CowlManager $manager 
  CowlOntology $ontology 
  UStrBuf $buf 

Documentation:

  Writes the ontology to the specified string buffer.
  
  @param manager The manager.
  @param ontology The ontology.
  @param buf The string buffer.
  @return Return code.

    C function name: cowl_manager_write_strbuf

write_stream

Signature:

  $self->write_stream(CowlOntology $ontology, UOStream $stream)

Params:

  CowlManager $manager 
  CowlOntology $ontology 
  UOStream $stream 

Documentation:

  Writes the ontology to the specified output stream.
  
  @param manager The manager.
  @param ontology The ontology.
  @param stream The output stream.
  @return Return code.
  
  @note The stream is not released by the manager, you must do it yourself.

    C function name: cowl_manager_write_stream

get_istream

Signature:

  $self->get_istream(CowlIStreamHandlers $handlers)

Params:

  CowlManager $manager 
  CowlIStreamHandlers $handlers 

Documentation:

  Returns an ontology input stream.
  
  @param manager The manager.
  @param handlers The handlers.
  @return Ontology input stream.

    C function name: cowl_manager_get_istream

get_istream_to_ontology

Signature:

  $self->get_istream_to_ontology(CowlOntology $ontology)

Params:

  CowlManager $manager 
  CowlOntology $ontology 

Documentation:

  Returns an ontology input stream that stores constructs in the specified ontology.
  
  @param manager The manager.
  @param ontology The ontology.
  @return Ontology input stream.

    C function name: cowl_manager_get_istream_to_ontology

get_ostream

Signature:

  $self->get_ostream(UOStream $stream)

Params:

  CowlManager $manager 
  UOStream $stream 

Documentation:

  Returns an ontology output stream.
  
  @param manager The manager.
  @param stream The output stream.
  @return Ontology output stream.

    C function name: cowl_manager_get_ostream

AUTHOR

Zakariyya Mughal <zmughal@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2024 by Auto-Parallel Technologies, Inc..

This is free software, licensed under Eclipse Public License - v 2.0.