27 |
|
|
28 |
=cut |
=cut |
29 |
|
|
30 |
|
=head1 Inheritable common methods |
31 |
|
|
32 |
|
This methods should really move somewhere else. |
33 |
|
|
34 |
=head2 _s |
=head2 _s |
35 |
|
|
36 |
Remove multiple whitespaces from string, as well as whitespaces at beginning or end |
Remove multiple whitespaces from string, as well as whitespaces at beginning or end |
60 |
This class implements Document which is collection of attributes |
This class implements Document which is collection of attributes |
61 |
(key=value), vectors (also key value) display text and hidden text. |
(key=value), vectors (also key value) display text and hidden text. |
62 |
|
|
63 |
|
|
64 |
=head2 new |
=head2 new |
65 |
|
|
66 |
Create new document, empty or from draft. |
Create new document, empty or from draft. |
180 |
push @{ $self->{htexts} }, $self->_s($text); |
push @{ $self->{htexts} }, $self->_s($text); |
181 |
} |
} |
182 |
|
|
183 |
|
|
184 |
=head2 id |
=head2 id |
185 |
|
|
186 |
Get the ID number of document. If the object has never been registred, C<-1> is returned. |
Get the ID number of document. If the object has never been registred, C<-1> is returned. |
194 |
return $self->{id}; |
return $self->{id}; |
195 |
} |
} |
196 |
|
|
197 |
|
|
198 |
=head2 attr_names |
=head2 attr_names |
199 |
|
|
200 |
Returns array with attribute names from document object. |
Returns array with attribute names from document object. |
240 |
return @{ $self->{dtexts} }; |
return @{ $self->{dtexts} }; |
241 |
} |
} |
242 |
|
|
243 |
|
|
244 |
=head2 cat_texts |
=head2 cat_texts |
245 |
|
|
246 |
Return whole text as single scalar. |
Return whole text as single scalar. |
254 |
return join(' ',@{ $self->{dtexts} }); |
return join(' ',@{ $self->{dtexts} }); |
255 |
} |
} |
256 |
|
|
257 |
|
|
258 |
=head2 dump_draft |
=head2 dump_draft |
259 |
|
|
260 |
Dump draft data from document object. |
Dump draft data from document object. |
287 |
return $draft; |
return $draft; |
288 |
} |
} |
289 |
|
|
290 |
|
|
291 |
=head2 delete |
=head2 delete |
292 |
|
|
293 |
Empty document object |
Empty document object |
340 |
$self ? return $self : return undef; |
$self ? return $self : return undef; |
341 |
} |
} |
342 |
|
|
343 |
|
|
344 |
=head2 set_phrase |
=head2 set_phrase |
345 |
|
|
346 |
$cond->set_phrase('search phrase'); |
$cond->set_phrase('search phrase'); |
352 |
$self->{phrase} = $self->_s( shift ); |
$self->{phrase} = $self->_s( shift ); |
353 |
} |
} |
354 |
|
|
355 |
|
|
356 |
=head2 add_attr |
=head2 add_attr |
357 |
|
|
358 |
$cond->add_attr('@URI STRINC /~dpavlin/'); |
$cond->add_attr('@URI STRINC /~dpavlin/'); |
365 |
push @{ $self->{attrs} }, $self->_s( $attr ); |
push @{ $self->{attrs} }, $self->_s( $attr ); |
366 |
} |
} |
367 |
|
|
368 |
|
|
369 |
=head2 set_order |
=head2 set_order |
370 |
|
|
371 |
$cond->set_order('@mdate NUMD'); |
$cond->set_order('@mdate NUMD'); |
377 |
$self->{order} = shift; |
$self->{order} = shift; |
378 |
} |
} |
379 |
|
|
380 |
|
|
381 |
=head2 set_max |
=head2 set_max |
382 |
|
|
383 |
$cond->set_max(42); |
$cond->set_max(42); |
391 |
$self->{max} = $max; |
$self->{max} = $max; |
392 |
} |
} |
393 |
|
|
394 |
|
|
395 |
=head2 set_options |
=head2 set_options |
396 |
|
|
397 |
$cond->set_options( SURE => 1 ); |
$cond->set_options( SURE => 1 ); |
420 |
$self->{options} ||= $options->{$option}; |
$self->{options} ||= $options->{$option}; |
421 |
} |
} |
422 |
|
|
423 |
|
|
424 |
=head2 phrase |
=head2 phrase |
425 |
|
|
426 |
Return search phrase. |
Return search phrase. |
434 |
return $self->{phrase}; |
return $self->{phrase}; |
435 |
} |
} |
436 |
|
|
437 |
|
|
438 |
=head2 order |
=head2 order |
439 |
|
|
440 |
Return search result order. |
Return search result order. |
448 |
return $self->{order}; |
return $self->{order}; |
449 |
} |
} |
450 |
|
|
451 |
|
|
452 |
=head2 attrs |
=head2 attrs |
453 |
|
|
454 |
Return search result attrs. |
Return search result attrs. |
463 |
return @{ $self->{attrs} }; |
return @{ $self->{attrs} }; |
464 |
} |
} |
465 |
|
|
466 |
|
|
467 |
=head2 max |
=head2 max |
468 |
|
|
469 |
Return maximum number of results. |
Return maximum number of results. |
479 |
return $self->{max}; |
return $self->{max}; |
480 |
} |
} |
481 |
|
|
482 |
|
|
483 |
=head2 options |
=head2 options |
484 |
|
|
485 |
Return options for this condition. |
Return options for this condition. |
531 |
$self ? return $self : return undef; |
$self ? return $self : return undef; |
532 |
} |
} |
533 |
|
|
534 |
|
|
535 |
=head2 uri |
=head2 uri |
536 |
|
|
537 |
Return URI of result document |
Return URI of result document |
560 |
return sort keys %{ $self->{attrs} }; |
return sort keys %{ $self->{attrs} }; |
561 |
} |
} |
562 |
|
|
563 |
|
|
564 |
=head2 attr |
=head2 attr |
565 |
|
|
566 |
Returns value of an attribute. |
Returns value of an attribute. |
575 |
return $self->{attrs}->{ $name }; |
return $self->{attrs}->{ $name }; |
576 |
} |
} |
577 |
|
|
578 |
|
|
579 |
=head2 snippet |
=head2 snippet |
580 |
|
|
581 |
Return snippet from result document |
Return snippet from result document |
589 |
return $self->{snippet}; |
return $self->{snippet}; |
590 |
} |
} |
591 |
|
|
592 |
|
|
593 |
=head2 keywords |
=head2 keywords |
594 |
|
|
595 |
Return keywords from result document |
Return keywords from result document |
634 |
$self ? return $self : return undef; |
$self ? return $self : return undef; |
635 |
} |
} |
636 |
|
|
637 |
|
|
638 |
=head2 doc_num |
=head2 doc_num |
639 |
|
|
640 |
Return number of documents |
Return number of documents |
648 |
return $#{$self->{docs}}; |
return $#{$self->{docs}}; |
649 |
} |
} |
650 |
|
|
651 |
|
|
652 |
=head2 get_doc |
=head2 get_doc |
653 |
|
|
654 |
Return single document |
Return single document |
667 |
return $self->{docs}->[$num]; |
return $self->{docs}->[$num]; |
668 |
} |
} |
669 |
|
|
670 |
|
|
671 |
=head2 hint |
=head2 hint |
672 |
|
|
673 |
Return specific hint from results. |
Return specific hint from results. |
724 |
$self ? return $self : return undef; |
$self ? return $self : return undef; |
725 |
} |
} |
726 |
|
|
727 |
|
|
728 |
=head2 set_url |
=head2 set_url |
729 |
|
|
730 |
Specify URL to node server |
Specify URL to node server |
738 |
$self->{url} = shift; |
$self->{url} = shift; |
739 |
} |
} |
740 |
|
|
741 |
|
|
742 |
=head2 set_proxy |
=head2 set_proxy |
743 |
|
|
744 |
Specify proxy server to connect to node server |
Specify proxy server to connect to node server |
755 |
$self->{pxport} = $port; |
$self->{pxport} = $port; |
756 |
} |
} |
757 |
|
|
758 |
|
|
759 |
=head2 set_timeout |
=head2 set_timeout |
760 |
|
|
761 |
Specify timeout of connection in seconds |
Specify timeout of connection in seconds |
771 |
$self->{timeout} = $sec; |
$self->{timeout} = $sec; |
772 |
} |
} |
773 |
|
|
774 |
|
|
775 |
=head2 set_auth |
=head2 set_auth |
776 |
|
|
777 |
Specify name and password for authentication to node server. |
Specify name and password for authentication to node server. |
788 |
$self->{auth} = $basic_auth; |
$self->{auth} = $basic_auth; |
789 |
} |
} |
790 |
|
|
791 |
|
|
792 |
=head2 status |
=head2 status |
793 |
|
|
794 |
Return status code of last request. |
Return status code of last request. |
804 |
return $self->{status}; |
return $self->{status}; |
805 |
} |
} |
806 |
|
|
807 |
|
|
808 |
=head2 put_doc |
=head2 put_doc |
809 |
|
|
810 |
Add a document |
Add a document |
871 |
) == 200; |
) == 200; |
872 |
} |
} |
873 |
|
|
874 |
|
|
875 |
|
=head2 edit_doc |
876 |
|
|
877 |
|
Edit attributes of a document |
878 |
|
|
879 |
|
$node->edit_doc( $document_draft ) or die "can't edit document"; |
880 |
|
|
881 |
|
Return true on success or false on failture. |
882 |
|
|
883 |
|
=cut |
884 |
|
|
885 |
|
sub edit_doc { |
886 |
|
my $self = shift; |
887 |
|
my $doc = shift || return; |
888 |
|
return unless ($self->{url}); |
889 |
|
$self->shuttle_url( $self->{url} . '/edit_doc', |
890 |
|
'text/x-estraier-draft', |
891 |
|
$doc->dump_draft, |
892 |
|
undef |
893 |
|
) == 200; |
894 |
|
} |
895 |
|
|
896 |
|
|
897 |
=head2 shuttle_url |
=head2 shuttle_url |
898 |
|
|
899 |
This is method which uses C<IO::Socket::INET> to communicate with Hyper Estraier node |
This is method which uses C<IO::Socket::INET> to communicate with Hyper Estraier node |