Java Doc for A_CmsVfsDocument.java in » Content-Management-System » opencms » org » opencms » search » documents » 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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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 » Content Management System » opencms » org.opencms.search.documents

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.opencms.search.documents .A_CmsVfsDocument

All known Subclasses:   org.opencms.search.documents .CmsDocumentMsExcel,  org.opencms.search.documents .CmsDocumentRtf,  org.opencms.search.documents .CmsDocumentPdf,  org.opencms.search.documents .CmsDocumentHtml,  org.opencms.search.documents .CmsDocumentMsPowerPoint,  org.opencms.search.documents .CmsDocumentOpenOffice,  org.opencms.search.documents .CmsDocumentXmlContent,  org.opencms.search.documents .CmsDocumentMsWord,  org.opencms.search.documents .CmsDocumentXmlPage,  org.opencms.search.documents .CmsDocumentPlainText,  org.opencms.search.documents .CmsDocumentGeneric,
A_CmsVfsDocument
abstract public class A_CmsVfsDocument implements I_CmsDocumentFactory(Code)
Base document factory class for a VFS org.opencms.file.CmsResource, just requires a specialized implementation of I_CmsDocumentFactory.extractContent(CmsObjectCmsResourceCmsSearchIndex) for text extraction from the binary document content.

author:
   Carsten Weinholz
author:
   Alexander Kandzior
version:
   $Revision: 1.18 $
since:
   6.0.0

Field Summary
final public static String SEARCH_PRIORITY_HIGH_VALUE
     Value for "high" search priority.
final public static String SEARCH_PRIORITY_LOW_VALUE
     Value for "low" search priority.
final public static String SEARCH_PRIORITY_MAX_VALUE
     Value for "maximum" search priority.
final public static String SEARCH_PRIORITY_NORMAL_VALUE
     Value for "normal" search priority.
final public static String VFS_DOCUMENT_KEY_PREFIX
     The vfs prefix for document keys.
protected String m_name
     Name of the documenttype.

Constructor Summary
public A_CmsVfsDocument(String name)


Method Summary
public Document createDocument(CmsObject cms, CmsResource resource, CmsSearchIndex index)

public CmsExtractionResultCache getCache()

public static String getDocumentKey(String type, String mimeType)

public List getDocumentKeys(List resourceTypes, List mimeTypes)

public String getName()

protected CmsFile readFile(CmsObject cms, CmsResource resource)

public void setCache(CmsExtractionResultCache cache)


Field Detail
SEARCH_PRIORITY_HIGH_VALUE
final public static String SEARCH_PRIORITY_HIGH_VALUE(Code)
Value for "high" search priority.

SEARCH_PRIORITY_LOW_VALUE
final public static String SEARCH_PRIORITY_LOW_VALUE(Code)
Value for "low" search priority.

SEARCH_PRIORITY_MAX_VALUE
final public static String SEARCH_PRIORITY_MAX_VALUE(Code)
Value for "maximum" search priority.

SEARCH_PRIORITY_NORMAL_VALUE
final public static String SEARCH_PRIORITY_NORMAL_VALUE(Code)
Value for "normal" search priority.

VFS_DOCUMENT_KEY_PREFIX
final public static String VFS_DOCUMENT_KEY_PREFIX(Code)
The vfs prefix for document keys.

m_name
protected String m_name(Code)
Name of the documenttype.

Constructor Detail
A_CmsVfsDocument
public A_CmsVfsDocument(String name)(Code)
Creates a new instance of this lucene document factory.

Parameters:
  name - name of the documenttype

Method Detail
createDocument
public Document createDocument(CmsObject cms, CmsResource resource, CmsSearchIndex index) throws CmsException(Code)
Generates a new lucene document instance from contents of the given resource for the provided index.

See Also:   org.opencms.search.documents.I_CmsDocumentFactory.createDocument(CmsObjectCmsResourceCmsSearchIndex)

getCache
public CmsExtractionResultCache getCache()(Code)

See Also:   org.opencms.search.documents.I_CmsDocumentFactory.getCache

getDocumentKey
public static String getDocumentKey(String type, String mimeType)(Code)
Creates a document factory lookup key for the given resource type name / MIME type configuration.
If the given mimeType is null, this indicates that the key should match all VFS resource of the given resource type regardless of the MIME type.

Parameters:
  type - the resource type name to use
Parameters:
  mimeType - the MIME type to use a document factory lookup key for the given resource id / MIME type configuration

getDocumentKeys
public List getDocumentKeys(List resourceTypes, List mimeTypes) throws CmsException(Code)

See Also:   org.opencms.search.documents.I_CmsDocumentFactory.getDocumentKeys(java.util.Listjava.util.List)

getName
public String getName()(Code)

See Also:   org.opencms.search.documents.I_CmsDocumentFactory.getName

readFile
protected CmsFile readFile(CmsObject cms, CmsResource resource) throws CmsException, CmsIndexException(Code)
Upgrades the given resource to a CmsFile with content.

Parameters:
  cms - the current users OpenCms context
Parameters:
  resource - the resource to upgrade the given resource upgraded to a CmsFile with content
throws:
  CmsException - if the resource could not be read
throws:
  CmsIndexException - if the resource has no content

setCache
public void setCache(CmsExtractionResultCache cache)(Code)

See Also:   org.opencms.search.documents.I_CmsDocumentFactory.setCache(org.opencms.search.documents.CmsExtractionResultCache)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.