Java Doc for CollectionManager.java in  » Search-Engine » zilverline » org » zilverline » service » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Search Engine » zilverline » org.zilverline.service 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.zilverline.service.CollectionManager

All known Subclasses:   org.zilverline.service.CollectionManagerImpl,
CollectionManager
public interface CollectionManager (Code)
The CollectionManager holds all collections, and base values for them.
author:
   Michael Franken
version:
   $Revision: 1.16 $
since:
   18 september 2004




Method Summary
 voidaddCollection(DocumentCollection col)
     Add collection to list of collections.
 AnalyzercreateAnalyzer()
     Returns an Analyzer for this collection based on configuration.
 voiddeleteCollection(DocumentCollection col)
     Deletes collection from list of collections.
 booleanexpandArchive(FileSystemCollection col, File zip)
     Expands Archive to disk.
 String[]getAllAnalyzers()
    
 String[]getAllExtractors()
    
 StringgetAnalyzer()
    
 HandlergetArchiveHandler()
     get the ArchiveHandler, which contains the mappings for unArchiving archives.
 FilegetCacheBaseDir()
     Get the cache base directory.
 DocumentCollectiongetCollection(Long theId)
     Gets a collection by id.
 DocumentCollectiongetCollectionByName(String theName)
     Gets a collection by name.
 ListgetCollections()
     Get all collections.
 ExtractorFactorygetFactory()
    
 FilegetIndexBaseDir()
     Get the base directory for the index.
 IntegergetMaxMergeDocs()
    
 IntegergetMergeFactor()
    
 IntegergetMinMergeDocs()
    
 IntegergetPriority()
    
 voidinit()
     Initializes all collections.
 booleanisIndexingInProgress()
     Indicates whether any indexing is going on.
 booleanisKeepCache()
     The default for all collections whether to keep cache dir after indexing.
 voidsetAnalyzer(String analyzerClassName)
     Create an Analyzer as specified by the given String.
Parameters:
  analyzerClassName - the name of the class.
 voidsetArchiveHandler(Handler handler)
     Set the ArchiveHandler.
 voidsetCacheBaseDir(File thisDir)
     The default cache base directory for all collections.
 voidsetFactory(ExtractorFactory thatFactory)
    
 voidsetIndexBaseDir(File thisDir)
     The default index base directory for all collections.
 voidsetKeepCache(boolean b)
     Indicates whether a Collection cache should be kept after indexing.
 voidsetMaxMergeDocs(Integer maxMergeDocs)
    
 voidsetMergeFactor(Integer mergeFactor)
    
 voidsetMinMergeDocs(Integer minMergeDocs)
    
 voidsetPriority(Integer priority)
    
 voidstore()
     Store the CollectionManager to store.
 FileunPack(File sourceFile, FileSystemCollection thisCollection)
     'unpacks' a given archive file into cache directory with derived name.



Method Detail
addCollection
void addCollection(DocumentCollection col)(Code)
Add collection to list of collections.
Parameters:
  col - Collection containing documents



createAnalyzer
Analyzer createAnalyzer()(Code)
Returns an Analyzer for this collection based on configuration. the Analyzer used to index and search this collection



deleteCollection
void deleteCollection(DocumentCollection col)(Code)
Deletes collection from list of collections.
Parameters:
  col - Collection containing documents



expandArchive
boolean expandArchive(FileSystemCollection col, File zip) throws IndexException(Code)
Expands Archive to disk. This is used is 'on-the-fly' extraction from cache
Parameters:
  col - the Collection to which cache this archive is extracted
Parameters:
  zip - the archive true if archive could be extracted
throws:
  IndexException -
See Also:   org.zilverline.web.CacheController



getAllAnalyzers
String[] getAllAnalyzers()(Code)
Returns the allAnalyzers.



getAllExtractors
String[] getAllExtractors()(Code)
Returns the allExtractors.



getAnalyzer
String getAnalyzer()(Code)
Returns the analyzer.



getArchiveHandler
Handler getArchiveHandler()(Code)
get the ArchiveHandler, which contains the mappings for unArchiving archives. object containing mappings for handling archives



getCacheBaseDir
File getCacheBaseDir()(Code)
Get the cache base directory. String the directory where the cache sits



getCollection
DocumentCollection getCollection(Long theId)(Code)
Gets a collection by id.
Parameters:
  theId - The id of the collection Collection or null if not found



getCollectionByName
DocumentCollection getCollectionByName(String theName)(Code)
Gets a collection by name.
Parameters:
  theName - The name of the collection Collection or null if not found



getCollections
List getCollections()(Code)
Get all collections. collections List of collections



getFactory
ExtractorFactory getFactory()(Code)
Returns the factory.



getIndexBaseDir
File getIndexBaseDir()(Code)
Get the base directory for the index. the directory



getMaxMergeDocs
Integer getMaxMergeDocs()(Code)
Returns the maxMergeDocs.



getMergeFactor
Integer getMergeFactor()(Code)
Returns the mergeFactor.



getMinMergeDocs
Integer getMinMergeDocs()(Code)
Returns the minMergeDocs.



getPriority
Integer getPriority()(Code)
Returns the priority.



init
void init() throws IndexException(Code)
Initializes all collections.
throws:
  IndexException - if the Collection can not be initialized or retrieved from store.



isIndexingInProgress
boolean isIndexingInProgress()(Code)
Indicates whether any indexing is going on. true if so.



isKeepCache
boolean isKeepCache()(Code)
The default for all collections whether to keep cache dir after indexing. whether to keep the cache or not.



setAnalyzer
void setAnalyzer(String analyzerClassName)(Code)
Create an Analyzer as specified by the given String.
Parameters:
  analyzerClassName - the name of the class. The class needs to be available on the classpath.



setArchiveHandler
void setArchiveHandler(Handler handler)(Code)
Set the ArchiveHandler.
Parameters:
  handler - object containing mappings for handling archives



setCacheBaseDir
void setCacheBaseDir(File thisDir)(Code)
The default cache base directory for all collections. The cache is the directory on disk where zipped content is unzipped for indexing.
Parameters:
  thisDir - the directory on disk



setFactory
void setFactory(ExtractorFactory thatFactory)(Code)

Parameters:
  thatFactory - The factory to set.



setIndexBaseDir
void setIndexBaseDir(File thisDir)(Code)
The default index base directory for all collections. The index is the directory on disk where a Lucene index is stored.
Parameters:
  thisDir - the directory on disk
See Also:   org.apache.lucene.index.IndexReader



setKeepCache
void setKeepCache(boolean b)(Code)
Indicates whether a Collection cache should be kept after indexing. The value of this CollectionManagerImpl functions as default for all Collections.
Parameters:
  b - keep cache or not.



setMaxMergeDocs
void setMaxMergeDocs(Integer maxMergeDocs)(Code)

Parameters:
  maxMergeDocs - The maxMergeDocs to set.



setMergeFactor
void setMergeFactor(Integer mergeFactor)(Code)

Parameters:
  mergeFactor - The mergeFactor to set.



setMinMergeDocs
void setMinMergeDocs(Integer minMergeDocs)(Code)

Parameters:
  minMergeDocs - The minMergeDocs to set.



setPriority
void setPriority(Integer priority)(Code)

Parameters:
  priority - The priority to set.



store
void store() throws IndexException(Code)
Store the CollectionManager to store.
throws:
  IndexException - when collectionManager can not be saved to underlying store



unPack
File unPack(File sourceFile, FileSystemCollection thisCollection)(Code)
'unpacks' a given archive file into cache directory with derived name. e.g. c:\temp\file.chm wil be unpacked into [cacheDir]\file_chm\.
Parameters:
  sourceFile - the Archive file to be unpacked
Parameters:
  thisCollection - the collection whose cache and contenDir is used File (new) directory containing unpacked file, null if unknown Archive



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.