/ 
Myco-0.01
River stage one • 2 direct dependents • 2 total dependents
/ Myco::Query::Part::Clause

NAME

Myco::Query::Part::Clause - a Myco entity class

VERSION

Release

0.01

Repository

$Revision$ $Date$

SYNOPSIS

use Myco;

# Constructors. See Myco::Base::Entity for more.
my $obj = Myco::Query::Part::Clause->new;

# Accessors.
my $value = $obj->get_fooattrib;
$obj->set_fooattrib($value);

$obj->save;
$obj->destroy;

DESCRIPTION

Blah blah blah... Blah blah blah... Blah blah blah... Blah blah blah blah blah... Blah blah...

COMMON ENTITY INTERFACE

Constructor, accessors, and other methods -- as inherited from Myco::Base::Entity.

ATTRIBUTES

Attributes may be initially set during object construction (with new()) but otherwise are accessed solely through accessor methods. Typical usage:

  • Set attribute value

    $obj->set_attribute($value);

    Check functions (see Class::Tangram) perform data validation. If there is any concern that the set method might be called with invalid data then the call should be wrapped in an eval block to catch exceptions that would result.

  • Get attribute value

    $value = $obj->get_attribute;

A listing of available attributes follows:

remote

type: transient

$query_clause->set_remote( '$p_' );

The remote variable name

attr

type: transient

# Last name
$query_clause->set_attr( 'last' );

The persistent attribute name corresponding to the remote API.

oper

type: transient

$query_clause->set_oper( 'ne' );

The Perl operator to be appended to the clause.

param

type: transient

$query_clause->set_param( 'Hancock' );

The parameter value used in the query clause. Certain method operators are multipart in nature, such as 'match', which takes a left regex operator, the param itself, and a right regex operator. Either of these operators may be left undefined. This will be discovered wehn calling 'get_clause'.

ADDED CLASS / INSTANCE METHODS

get_clause

Myco::Query::Part::Clause->get_clause;

Concatenates into a string cluase the atomic parts of a Myco::Query::Part::Clause. Accepts an argument a hash of parameters that are marked as optional in the ::Query 'params' attribute.

LICENSE AND COPYRIGHT

Copyright (c) 2004 the myco project. All rights reserved. This software is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

Myco::Query::Part::Clause::Test, Myco::Base::Entity, Myco, Tangram, Class::Tangram, mkentity