Java Doc for ResourceMapping.java in » Search-Engine » compass-2.0 » org » compass » core » mapping » 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 » Search Engine » compass 2.0 » org.compass.core.mapping

Source Cross Reference Class Diagram Java Document (Java Doc)

org.compass.core.mapping .ResourceMapping

All known Subclasses:   org.compass.core.mapping.osem .ClassMapping,
ResourceMapping
public interface ResourceMapping extends AliasMapping(Code)
A mapping defining a org.compass.core.Resource saved in the Search Engine.
author:
   kimchy

Method Summary
AllMapping getAllMapping()
     Returns a set of settings associated with the all mappings.
String getAnalyzer()
     Returns the analyzer name that need to be used with the resouce.
ResourceAnalyzerController getAnalyzerController()
     Returns the analzer controller that is associated with the org.compass.core.Resource .
float getBoost()
     Returns the boost of the given resource.
BoostPropertyMapping getBoostPropertyMapping()
     Returns an optional boost property mapping associated with the org.compass.core.Resource in order to dynmaically set the resource boost value based on it.
CascadeMapping[] getCascadeMappings()
     Returns a list of all the cascade mappings.
Mapping[] getIdMappings()
     Returns all mappings that represent ids of a resource.
ResourcePropertyMapping[] getResourceIdMappings()
     Returns all the id mappigns for the low level resource mapping.
ResourcePropertyMapping getResourcePropertyMapping(String propertyName)
     Returns the first resource property mapping that match the given proeprty name ( org.compass.core.mapping.ResourcePropertyMapping.getName , or null if not exists.
ResourcePropertyMapping getResourcePropertyMappingByDotPath(String path)
     Returns the ResourcePropertyMapping that match the given path "dot" path (a.bValue.value), or null if none exists.
ResourcePropertyMapping getResourcePropertyMappingByPath(PropertyPath path)
     Returns the ResourcePropertyMapping that match the given path ( org.compass.core.mapping.ResourcePropertyMapping.getPath , or null of not exists.
ResourcePropertyMapping[] getResourcePropertyMappings()
     Returns all the resource property mappings that are assoicated with the resource mapping.
ResourcePropertyMapping[] getResourcePropertyMappings(String propertyName)
     Returns the list of resource property mappings that match the given proeprty name ( org.compass.core.mapping.ResourcePropertyMapping.getName , or null if not exists.
String[] getResourcePropertyNames()
     Returns all the mapped property names for the resoruce.
SpellCheckType getSpellCheck()
     Returns the default spell check mode.
SubIndexHash getSubIndexHash()
     The sub index that the org.compass.core.Resource will be saved to in the search engine.
String getUIDPath()
     Returns the uid property name.
boolean hasSpecificAnalyzerPerResourceProperty()
     Returns true if the resource proeprty mapping of the resource have a specific analyzer set.
boolean isRoot()
     Returns true if it is a root resource mapping.
boolean operationAllowed(CascadeMapping.Cascade cascade)
     Returns is an operation is allowed to be performed on this resoruce mappings.

Method Detail
getAllMapping
AllMapping getAllMapping()(Code)
Returns a set of settings associated with the all mappings.

getAnalyzer
String getAnalyzer()(Code)
Returns the analyzer name that need to be used with the resouce. Can be null.

getAnalyzerController
ResourceAnalyzerController getAnalyzerController()(Code)
Returns the analzer controller that is associated with the org.compass.core.Resource . Can be null.

getBoost
float getBoost()(Code)
Returns the boost of the given resource.

getBoostPropertyMapping
BoostPropertyMapping getBoostPropertyMapping()(Code)
Returns an optional boost property mapping associated with the org.compass.core.Resource in order to dynmaically set the resource boost value based on it. Can be null.

getCascadeMappings
CascadeMapping[] getCascadeMappings()(Code)
Returns a list of all the cascade mappings. Will return null if no cascading is defined.

getIdMappings
Mapping[] getIdMappings()(Code)
Returns all mappings that represent ids of a resource.

getResourceIdMappings
ResourcePropertyMapping[] getResourceIdMappings()(Code)
Returns all the id mappigns for the low level resource mapping.

getResourcePropertyMapping
ResourcePropertyMapping getResourcePropertyMapping(String propertyName)(Code)
Returns the first resource property mapping that match the given proeprty name ( org.compass.core.mapping.ResourcePropertyMapping.getName , or null if not exists.

getResourcePropertyMappingByDotPath
ResourcePropertyMapping getResourcePropertyMappingByDotPath(String path)(Code)
Returns the ResourcePropertyMapping that match the given path "dot" path (a.bValue.value), or null if none exists.

getResourcePropertyMappingByPath
ResourcePropertyMapping getResourcePropertyMappingByPath(PropertyPath path)(Code)
Returns the ResourcePropertyMapping that match the given path ( org.compass.core.mapping.ResourcePropertyMapping.getPath , or null of not exists.

getResourcePropertyMappings
ResourcePropertyMapping[] getResourcePropertyMappings()(Code)
Returns all the resource property mappings that are assoicated with the resource mapping. Note, that it is an important method, since it might be that not all the mappings that were added to the resource mapping are of type ResourcePropertyMapping , and using this method you can be assured that ALL the ResourcePropertyMapping s will be returned (even deep ones).

getResourcePropertyMappings
ResourcePropertyMapping[] getResourcePropertyMappings(String propertyName)(Code)
Returns the list of resource property mappings that match the given proeprty name ( org.compass.core.mapping.ResourcePropertyMapping.getName , or null if not exists.

getResourcePropertyNames
String[] getResourcePropertyNames()(Code)
Returns all the mapped property names for the resoruce.

getSpellCheck
SpellCheckType getSpellCheck()(Code)
Returns the default spell check mode. If NA, will use global setting.

getSubIndexHash
SubIndexHash getSubIndexHash()(Code)
The sub index that the org.compass.core.Resource will be saved to in the search engine.

getUIDPath
String getUIDPath()(Code)
Returns the uid property name.

hasSpecificAnalyzerPerResourceProperty
boolean hasSpecificAnalyzerPerResourceProperty()(Code)
Returns true if the resource proeprty mapping of the resource have a specific analyzer set.

isRoot
boolean isRoot()(Code)
Returns true if it is a root resource mapping. If it is a root mapping, then it controlls the general org.compass.core.Resource level settings like alias and sub-index. Usually, non-root resource mapping are mappings that are incorporated within another resoruce.

operationAllowed
boolean operationAllowed(CascadeMapping.Cascade cascade)(Code)
Returns is an operation is allowed to be performed on this resoruce mappings. Root mappings ( ResourceMapping.isRoot() always return true, while if it is non root mappings, it should return true if it has cascade mappings that map one of the cascade operations.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.