Java Doc for SearchableIdComponent.java in  » Search-Engine » compass-2.0 » org » compass » annotations » 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 » compass 2.0 » org.compass.annotations 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.compass.annotations.SearchableIdComponent

SearchableIdComponent
public @interface SearchableIdComponent(Code)
Specifies a searchable id component on property or field of the org.compass.annotations.Searchable class.

A searchable id component is a class field/property that reference another class, which content need to be embedded into the content of its org.compass.annotations.Searchable class and represents one of its ids.

The referenced class must have searchable definitions, defined either using annotations or other means (like xml).

Compass will try to automatically identify the searchable class mapping definitions that map to the component class. If the mappings can not be automatically identified, the SearchableIdComponent.refAlias() should be used to reference the alias that has the searchable class mapping definition.

The searchable component can annotate a java.util.Collection type field/property, supporting either java.util.List or java.util.Set . The searchable component will try and automatically identify the element type using generics, but if the collection is not defined with generics, SearchableIdComponent.refAlias() should be used to reference the component searchable class mapping definitions.

The searchable component can annotate an array as well, with the array element type used for referenced searchable class mapping definitions.
author:
   kimchy
See Also:   org.compass.annotations.Searchable
See Also:   org.compass.annotations.SearchableReference



Field Summary
abstract public  Stringaccessor
     The property accessor that will be fetch and write the property value.

It is automatically set based on where the annotation is used, but can be explicitly set.

abstract public  Cascade[]cascade
     The operations that will cascade to the target association.
abstract public  Stringconverter
     The conveter lookup name that will convert the org.compass.core.mapping.osem.ComponentMapping .
abstract public  intmaxDepth
     The depth of cyclic component references allowed.
abstract public  booleanoverride
     Should the component definitions override an already existing component definitions for the same field/property.
abstract public  StringrefAlias
     The reference alias that points to the searchable class (either defined using annotations or xml).



Field Detail
accessor
abstract public String accessor(Code)
The property accessor that will be fetch and write the property value.

It is automatically set based on where the annotation is used, but can be explicitly set. Compass also supports custom property accessors, registered under a custom name, which can then be used here as well.




cascade
abstract public Cascade[] cascade(Code)
The operations that will cascade to the target association. Defaults to no operations being cascaded.



converter
abstract public String converter(Code)
The conveter lookup name that will convert the org.compass.core.mapping.osem.ComponentMapping . Defaults to compass own intenral org.compass.core.converter.mapping.osem.ComponentMappingConverter .



maxDepth
abstract public int maxDepth(Code)
The depth of cyclic component references allowed.



override
abstract public boolean override(Code)
Should the component definitions override an already existing component definitions for the same field/property.



refAlias
abstract public String refAlias(Code)
The reference alias that points to the searchable class (either defined using annotations or xml). Not required since most of the times it can be automatically detected.





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