view release on metacpan or  search on metacpan

XS/CQuery.pod  view on Meta::CPAN

 #----------------------------------------------------------------------
 # DDC::XS::CQNear : @ISA=qw(DDC::XS::CQNegatable);
 
 # Constructors etc.
 $CQNear = DDC::XS::CQNear->new($dist, $dtr1, $dtr2, $dtr3);
 
 # Accessors
 $CQuery = $CQNear->getDtr1();
 undef   = $CQNear->setDtr1($dtr1);
 $CQuery = $CQNear->getDtr2();
 undef   = $CQNear->setDtr2($dtr2);
 $CQuery = $CQNear->getDtr3();
 undef   = $CQNear->setDtr3($dtr3);
 $BYTE   = $CQNear->getDist();
 undef   = $CQNear->setDist($Dist);

 #----------------------------------------------------------------------
 # DDC::XS::CQSeq : @ISA=qw(DDC::XS::CQAtomic);
 
 # Constructors etc.
 $CQSeq = DDC::XS::CQSeq->new1     ($item);
 $CQSeq = DDC::XS::CQSeq->new      (\@items, \@dists, \@distops);
 
 # Accessors
 \@CQTokens = $CQSeq->getItems();
 undef      = $CQSeq->setItems(\@Items);
 \@Dists    = $CQSeq->getDists();
 undef      = $CQSeq->setDists(\@Dists);
 \@DistOps  = $CQSeq->getDistOps();
 undef      = $CQSeq->setDistOps(\@DistOps);
 
 # Methods
 undef = $CQSeq->Append($nextItem, $nextDist, $nextDistOp);


=cut

##======================================================================

=pod

=head1 DESCRIPTION

The DDC::XS::CQuery hierarchy provides perl wrappers for  the DDC C++ CQuery classes.
DDC parsed query objects can be created either manually from perl using
the constructors above, or parsed from a query string using
the L<DDC::XS::CQueryCompiler|DDC::XS::CQueryCompiler> interface.
In either case, DDC::XS::CQuery and all other DDC::XS::Object descendants
use an internal reference counting strategy in addition to perl's reference counts;
see L<DDC::XS::Object> for details.
The L<DDC::XS::Object|DDC::XS::Object> methods toHash() and newFromHash()
may be useful for mapping back and forth between the "opaque" objects
in the DDC::XS hierarchy and perl representations of these encoded as
HASH-refs, since perl's internal reference-counting strategy applies
to the latter.


=head1 KNOWN BUGS

Objects should be transparently encoded/decoded to and from perl hash representations.

=head1 SEE ALSO

perl(1),
DDC::XS(3perl),
DDC::XS::Object(3perl),
DDC::XS::CQCount(3perl),
DDC::XS::CQFilter(3perl),
DDC::XS::CQueryOptions(3perl),
DDC::XS::CQueryCompiler(3perl).

=head1 AUTHOR

Bryan Jurish E<lt>moocow@cpan.orgE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2015 by Bryan Jurish

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.2 or,
at your option, any later version of Perl 5 you may have available.

=cut