File Coverage

blib/lib/DBIx/Romani/Query/Function.pm

Criterion	Covered	Total	%
statement	3	23	13.0
branch			n/a
condition			n/a
subroutine	1	7	14.2
pod	0	6	0.0
total	4	36	11.1

package DBIx::Romani::Query::Function;

=begin xmldoc

 DBIx::Romani::Query::Function


	# Don't use directy, create a sub-class!
	use DBIx::Romani::Query::Function;
	my $func = DBIx::Romani::Query::Function->new();
	$func->add( DBIx::Romani::Query::SQL::Column->new('column_name') );



	The parent class of all query functions.  A query function is something
	like COUNT() in SQL, but can include control flow functions that are
	executed in the query engine and not in SQL.  This class is abstract and
	can't be used directly.


=cut

use strict;

=begin xmldoc


	 new()
	 Constructs a new query object
	 none


=cut
sub new
{
	my $class = shift;
	my $args  = shift;

	my $self = {
		arguments => [ ]
	};

	bless  $self, $class;
	return $self;
}

=begin xmldoc


	 get_arguments()
	 Gets the argument list.
	 A list reference.
	 none


=cut
sub get_arguments { return shift->{arguments}; }

=begin xmldoc


	 add()
	 Add an object to the argument list
	 object


=cut
sub add
{
	my ($self, $arg) = @_;
	push @{$self->{arguments}}, $arg;
}

=begin xmldoc


	 visit()
	 Abstract method to "execute" the function
	 visitor
	 The result of the function


=cut
sub visit
{
	die "Abstract.";
}

sub copy_arguments
{
	my ($self, $other) = @_;

	foreach my $arg ( @{$other->get_arguments()} )
	{
		$self->add_arguments( $arg->clone() );
	}
}

sub clone
{
	my $self = shift;
	my $class = ref($self);

	my $clone;
	$clone = $class->new();
	$clone->copy_arguments( $self );

	return $clone;
}

1;