NAME

DDC::Query - pure-perl wrapper for parsed DDC queries [DEPRECATED]

PACKAGES

DDC::Query
DDC::Query::Root
DDC::Query::Negatable
DDC::Query::BinOp
DDC::Query::And
DDC::Query::Or
DDC::Query::With
DDC::Query::Atomic
DDC::Query::Token
DDC::Query::TokExact
DDC::Query::TokExpand
DDC::Query::TokPrefix
DDC::Query::TokSuffix
DDC::Query::TokInfix
DDC::Query::TokRegex
DDC::Query::Any
DDC::Query::TokSet
DDC::Query::TokSetExpand
DDC::Query::TokSetExact
DDC::Query::TokSetPrefix
DDC::Query::TokSetSuffix
DDC::Query::TokSetInfix
DDC::Query::TokThes
DDC::Query::TokMorph
DDC::Query::TokLemma
DDC::Query::TokChunk
DDC::Query::TokAnchor
DDC::Query::TokFile
DDC::Query::Near
DDC::Query::Phrase
DDC::Query::Seq

SYNOPSIS

##========================================================================
## PRELIMINARIES

use DDC::Query;

DDC::Query Synopsis

##========================================================================
## Constructors etc.

$q = $CLASS_OR_OBJ->new(%args);
$q = $q->negate();
$bool = $q->negatable();
$bool = $q->negated();
@items = $q->expandItems();
@dtrs = $q->dtrs();
$str = $q->toString();
\@nodes = $q->dfs();

##========================================================================
## Root: root queries (with filters)

$q = $CLASS_OR_OBJ->new(%args);
$str = $q->toString();

DDC::Query::Root Synopsis

##========================================================================
## Negatable: negatable queries

$bool = $q->negatable();
$str = $q->negString($str);

DDC::Query::Negatable Synopsis

##========================================================================
## BinOp

DDC::Query::BinOp Synopsis

##========================================================================
## Q1 && Q2

DDC::Query::And Synopsis

##========================================================================
## Q1 || Q2

DDC::Query::Or Synopsis

##========================================================================
## Q1 with Q2

$bool = $q->negatable();

DDC::Query::With Synopsis

DDC::Query::Atomic Synopsis

##========================================================================
## Token: single-token queries

$str = $q->indexString()       ##-- uses $q->{index};
$str = $q->valueString() ##-- uses $q->{value};
$str = $q->expandString() ##-- uses $q->{expand};

DDC::Query::Token Synopsis

##========================================================================
## $INDEX=@WORD

DDC::Query::TokExact Synopsis

DDC::Query::TokExpand Synopsis

##========================================================================
## $INDEX=WORD*

DDC::Query::TokPrefix Synopsis

##========================================================================
## $INDEX=*WORD

DDC::Query::TokSuffix Synopsis

##========================================================================
## $INDEX=*WORD*

DDC::Query::TokInfix Synopsis

##========================================================================
## $INDEX=/REGEX/

DDC::Query::TokRegex Synopsis

##========================================================================
## $INDEX=*

DDC::Query::Any Synopsis

##========================================================================
## TokSet: $INDEX={W1,W2,...} : abstract

$str = $q->valueString() ##-- uses $q->{values};

DDC::Query::TokSet Synopsis

##========================================================================
## TokSetExpand: $INDEX={W1,W2,...}

@items = $q->expandItems();

DDC::Query::TokSetExpand Synopsis

##========================================================================
## TokSetExact: $INDEX=@{W1,W2,...}

DDC::Query::TokSetExact Synopsis

##========================================================================
## TokSetPrefix: $INDEX={W1,W2,...}*

DDC::Query::TokSetPrefix Synopsis

##========================================================================
## TokSetSuffix: $INDEX=*{W1,W2,...}

DDC::Query::TokSetSuffix Synopsis

##========================================================================
## TokSetInfix: $INDEX=*{W1,W2,...}*

DDC::Query::TokSetInfix Synopsis

##========================================================================
## TokThes: $INDEX={THES1:THES2:...}

DDC::Query::TokThes Synopsis

##========================================================================
## TokMorph: $INDEX=[M1,M2,..]

DDC::Query::TokMorph Synopsis

##========================================================================
## TokLemma: $INDEX=%LEMMA

DDC::Query::TokLemma Synopsis

##========================================================================
## TokChunk: $INDEX=^CHUNK

DDC::Query::TokChunk Synopsis

##========================================================================
## TokAncor: $.BREAK=POSITION

DDC::Query::TokAnchor Synopsis

##========================================================================
## <FILE

DDC::Query::TokFile Synopsis

##========================================================================
## Near :

DDC::Query::Near Synopsis

##========================================================================
## Phrase: "W1 #D1 W2 ... WN"

DDC::Query::Phrase Synopsis

(no documentation found for package DDC::Query::Phrase)

DDC::Query::Seq Synopsis

(no documentation found for package DDC::Query::Seq)

DESCRIPTION

The DDC::Query hierarchy provides pure-perl wrapper classes for parsed DDC queries. Its use is deprecated in favor of the DDC::XS::CQuery class hierarchy providing direct access to the underlying C++ libraries.

DDC::Query Description

Globals etc.

Variable: @ISA

(undocumented)

Constructors etc.

new
$q = $CLASS_OR_OBJ->new(%args);

%args, %$q:

(
 class   => $class,     ##-- subclass
 dtrs    => \@args,     ##-- array of sub-queries (e.g. DDC::Query objects)
 #...
)
negate
$q = $q->negate();

(undocumented)

negatable
$bool = $q->negatable();

(undocumented)

negated
$bool = $q->negated();

(undocumented)

expandItems
@items = $q->expandItems();

returns list of source items to be expanded (e.g. by CAB); empty list for none

dtrs
@dtrs = $q->dtrs();

(undocumented)

toString
$str = $q->toString();

stringification operator

dfs
\@nodes = $q->dfs();

returns query nodes in depth-first search order

Root: root queries (with filters)

Variable: @ISA

(undocumented)

new
$q = $CLASS_OR_OBJ->new(%args);

%args, %$q:

(
 root => $q,            ##-- query root
 filters => \@filters,  ##-- array of DDC::Query::Filter objects
)
dtrs

(undocumented)

toString
$str = $q->toString();

stringification operator

DDC::Query::Root Description

Negatable: negatable queries

Variable: @ISA

(undocumented)

negatable
$bool = $q->negatable();

(undocumented)

negString
$str = $q->negString($str);

stringification operator

DDC::Query::Negatable Description

BinOp

Variable: @ISA

(undocumented)

new

(undocumented)

toString

(undocumented)

DDC::Query::BinOp Description

Q1 && Q2

Variable: @ISA

(undocumented)

new

(undocumented)

DDC::Query::And Description

Q1 || Q2

Variable: @ISA

(undocumented)

new

(undocumented)

DDC::Query::Or Description

Q1 with Q2

Variable: @ISA

(undocumented)

new

(undocumented)

negatable
$bool = $q->negatable();

(undocumented)

DDC::Query::With Description

Atomic: sequenceable queries

Variable: @ISA

(undocumented)

DDC::Query::Atomic Description

Token: single-token queries

Variable: @ISA

(undocumented)

new

(undocumented)

toString

(undocumented)

indexString
$str = $q->indexString()       ##-- uses $q->{index};

$str = $q->indexString($index)

valueString
$str = $q->valueString() ##-- uses $q->{value};

$str = $q->valueString($val)

expandString
$str = $q->expandString() ##-- uses $q->{expand};

$str = $q->expandString(\@expand)

DDC::Query::Token Description

$INDEX=@WORD

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokExact Description

$INDEX=WORD

Variable: @ISA

(undocumented)

DDC::Query::TokExpand Description

$INDEX=WORD*

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokPrefix Description

$INDEX=*WORD

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokSuffix Description

$INDEX=*WORD*

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokInfix Description

$INDEX=/REGEX/

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokRegex Description

$INDEX=*

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::Any Description

TokSet: $INDEX={W1,W2,...} : abstract

Variable: @ISA

(undocumented)

new

(undocumented)

valueString
$str = $q->valueString() ##-- uses $q->{values};

$str = $q->valueString(\@values) returned string includes brackets

DDC::Query::TokSet Description

TokSetExpand: $INDEX={W1,W2,...}

Variable: @ISA

(undocumented)

new

(undocumented)

expandItems
@items = $q->expandItems();

(undocumented)

DDC::Query::TokSetExpand Description

TokSetExact: $INDEX=@{W1,W2,...}

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokSetExact Description

TokSetPrefix: $INDEX={W1,W2,...}*

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokSetPrefix Description

TokSetSuffix: $INDEX=*{W1,W2,...}

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokSetSuffix Description

TokSetInfix: $INDEX=*{W1,W2,...}*

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokSetInfix Description

TokThes: $INDEX={THES1:THES2:...}

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokThes Description

TokMorph: $INDEX=[M1,M2,..]

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokMorph Description

TokLemma: $INDEX=%LEMMA

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokLemma Description

TokChunk: $INDEX=^CHUNK

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokChunk Description

TokAncor: $.BREAK=POSITION

Variable: @ISA

(undocumented)

indexString

(undocumented)

DDC::Query::TokAnchor Description

<FILE

Variable: @ISA

(undocumented)

valueString

(undocumented)

DDC::Query::TokFile Description

Near :

Variable: @ISA

(undocumented)

new

(undocumented)

toString

(undocumented)

DDC::Query::Near Description

Phrase: "W1 #D1 W2 ... WN"

Variable: @ISA

(undocumented)

Variable: @ISA

(undocumented)

new

(undocumented)

dtrs

(undocumented)

toString

(undocumented)

DDC::Query::Phrase Description

(no documentation found for package DDC::Query::Phrase)

DDC::Query::Seq Description

(no documentation found for package DDC::Query::Seq)

ACKNOWLEDGEMENTS

perl by Larry Wall.

AUTHOR

Bryan Jurish <moocow@cpan.org>

COPYRIGHT

Copyright (c) 2011-2015, Bryan Jurish. All rights reserved.

This package is free software. You may redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

perl(1), DDC::XS(3perl).