NAME

Dicop::Data::Charset::Extract - describes string extraction from a file

SYNOPSIS

    use Dicop::Data::Charset::Extract;

REQUIRES

perl5.008001, Exporter, Dicop::Base, Dicop::Item, Dicop, Dicop::Event, Math::BigInt

EXPORTS

Exports nothing on default.

DESCRIPTION

A dictionary charset has the following fields, most of them can be set via new. The rest (shown with a *) is automatically initialized/overwritten/maintained:

set

The simple charset used to describe which characters should be extracted.

description

A short description.

id *

The identification number.

dirty *

If set to 1, the charset is considered 'in use' and can no longer be changed. (Actually, only the set, the description still can be changed)

This is to prevent changes to a charset that is currently used by a job, since that would invalidate the job's keyspace.

METHODS

check()

Perform an internal check and return '' for okay, otherwise an error message.

type()

Returns the type, in this case the string 'extract'.

charset()

Return the internal Math::String::Charset object.

extract_set()

Return the internal Math::String::Charset object, that is describing the strings that should be extracted.

check_strings()

        $error = $self->check_strings ($hash, @keys);

Take a hash reference and a list of keys. For each of the keys in the hash, check that it is an object of the underlying charset. If not, create an object out of it.

To satisify external code, creates Math::String objects from the keys with a charset containing '.'..'9'.

image_file_name()

Store the image file name, and set start/end from the image file size.

BUGS

None known yet.

AUTHOR

DiCoP is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

See http://www.bsi.de/ for more information.