NAME

SQL::QueryBuilder::Pretty::Rule - Base module for SQL::QueryBuilder::Pretty's rules.

VERSION

Version 0.01

SYNOPSIS

    package SQL::QueryBuilder::Pretty::Database::ANSI::LogicOperator;
    use base qw(SQL::QueryBuilder::Pretty::Rule);

    sub order { return 70 }

    sub match { 
        return qr/
            AND|OR
        /x;
    }

    sub action {
        my $self  = shift;
        my $print = shift;
        my $token = shift;

        $print->new_line;
        $print->var( $print->current_indent );
        $print->var($token);

        return 1;
    }

    1;

DESCRIPTION

Base object for SQL::QueryBuilder::Pretty's rules.

METHODS

PACKAGE->new()

Initializes the object.

$obj->action($print_object, $token)

THe action to be executed on match. Must return 1 to skip the next rules.

$print_object is a SQL::QueryBuilder::Pretty::Print object.

$token is the result of the match.

$obj->match

Returns the match regular expression for this rule.

$obj->name

Returns the name of the rule. By default the pm file. Not used yet.

$obj->order

Returns the order value for this rule. Default is 999.

$obj->type

Returns the type of this rule. Not used yet.

SEE ALSO

SQL::QueryBuilder::Pretty and SQL::QueryBuilder::Pretty::Print.

AUTHOR

André Rivotti Casimiro, <rivotti at cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2009 by André Rivotti Casimiro. Published under the terms of the Artistic License 2.0.