Mark Leeuw > SVN-TeamTools-Indexer-0.002 > SVN::TeamTools::Store::SvnIndex

Download:
SVN-TeamTools-Indexer-0.002.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.002   Source  

NAME ^

SVN::TeamTools::Store::SvnIndex

SYNOPSIS ^

use SVN::TeamTools::Store::SvnIndex;

my $svnindex = SvnIndex->new (mode=>"rw", create=>1);

DESCRIPTION ^

Used by various SVN::TeamTools modules to access the index. See the 'Indexer' module for more information on how to use the index. The SvnIndex distinguished revisions, documents and links. A revision contains the revision log message and lists of added and deleted files. A document is a file within the repository. The 'link' type was introduced to save space and processing power. If a large trunk is copied to a branch for a development project, in general only a limited amount of files is actually modified. In this example, all files contained by the trunk will be created as linked objects in the new branch (in the search index). All routines within SVN::TeamTools automatically extend search results (on documents) with all their linked objects. As soon a the file in the branch is modified (and committed), the link is removed and the file is stored in the search index as a document.

Methods

new

Creates a new index object. Parameters: mode: r for read only, rw for read-write access create: if set, the index is recreated.

linkSearch

Parameter 'path' (String).

Returns: a Lucy query result.

Finds the 'links' to the specified path, e.g. entities in SubVersion that where created during a branch (copy) operation.

addDoc

Only for use by the Indexer

addLink

Only for use by the Indexer

deleteDoc

Only for use by the Indexer

addRev

Only for use by the Indexer

hasAction

Only for internal use by the web interface

getTemplate

Only for internal use by the web interface

getData

Only for internal use by the web interface

store

Only for internal use by the web interface

AUTHOR ^

Mark Leeuw (markleeuw@gmail.com)

COPYRIGHT AND LICENSE ^

This software is copyrighted by Mark Leeuw

This is free software; you can redistribute it and/or modify it under the restrictions of GPL v2

syntax highlighting: