Java Doc for CompassMapping.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
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.core.mapping 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.compass.core.mapping.CompassMapping

CompassMapping
public class CompassMapping (Code)

author:
   kimchy



Constructor Summary
public  CompassMapping()
    

Method Summary
public  voidaddMapping(AliasMapping mapping)
    
public  voidclearMappings()
    
public  CompassMappingcopy(ConverterLookup converterLookup)
    
public  ResourceMappingfindNonRootMappingByClass(Class clazz)
     Finds a non root mapping by the class name.
public  ResourceMappingfindRootMappingByClass(Class clazz)
     Finds a root mapping by the class name.
public  AliasMappinggetAliasMapping(String alias)
     Returns the alias mapping for the given alias (most if not all of the times, this will be a org.compass.core.mapping.ResourceMapping ).
public  List<ResourceMapping>getAllDirectMappingByClass(Class clazz)
     Returns all the direct class mapping for the given class (root or not).
public  ConverterLookupgetConverterLookup()
    
public  ResourceMappinggetDirectMappingByClass(Class clazz)
     Returns the direct class mapping for the given class (root or not).
public  ResourceMappinggetMappingByAlias(String alias)
     Returns the resource mapping for the given alias.
public  ResourceMappinggetMappingByClass(Class clazz)
     Finds the Resource mapping that is the "nearest" to the provided class.
public  ResourceMappinggetNonRootMappingByAlias(String alias)
     Returns the non root resource mapping associated with the alias.
public  ResourceMappinggetNonRootMappingByClass(Class clazz)
     Does exactly the same as CompassMapping.findNonRootMappingByClass(Class) , but returns null if nothing is found (does not throw an exception).
public  PropertyPathgetPath()
    
public  ResourcePropertyLookupgetResourcePropertyLookup(String name)
     Returns a resoruce lookup for a specific name.
public  ResourcePropertyMappinggetResourcePropertyMappingByPath(String path)
     Finds the ResourcePropertyMapping definition for the specified path.
public  ResourcePropertyMapping[]getResourcePropertyMappingsByPath(String path)
     Returns an array of all the given org.compass.core.mapping.ResourcePropertyMapping for the given path.
public  ResourceMappinggetRootMappingByAlias(String alias)
     Returns the root resource mapping associated with the alias.
public  ResourceMappinggetRootMappingByClass(Class clazz)
     Does exactly the same as CompassMapping.findRootMappingByClass(Class) , but returns null if nothing is found (does not throw an exception).
public  ResourceMapping[]getRootMappings()
    
public  booleanhasMultipleRootClassMapping(String className)
     Returns true if the given className has multiple class mappings.
public  booleanhasRootClassMapping(String alias)
     Returns true if there is a root org.compass.core.mapping.osem.ClassMapping for the given alias.
public  booleanhasRootMappingByAlias(String alias)
     Returns true if the given alias has a root resource mapping.
public  booleanhasRootRawResourceMapping(String alias)
     Returns true if there is a root org.compass.core.mapping.rsem.RawResourceMapping for the given alias.
public  IteratormappingsIt()
     Returns an itertor over all the current mappings.
public  voidpostProcess()
    
public  voidsetPath(PropertyPath path)
    


Constructor Detail
CompassMapping
public CompassMapping()(Code)




Method Detail
addMapping
public void addMapping(AliasMapping mapping) throws MappingException(Code)



clearMappings
public void clearMappings()(Code)



copy
public CompassMapping copy(ConverterLookup converterLookup)(Code)



findNonRootMappingByClass
public ResourceMapping findNonRootMappingByClass(Class clazz) throws MappingException(Code)
Finds a non root mapping by the class name. If a non root mapping is not found for the class name, than searches for mappings for the interfaces, if not found, checks for subclasses, and subclassess interfaces. Note: If there is no direct mapping that match the class name, then the mapping that is found should be marked as poly.
Parameters:
  clazz - The class to find root mapping for The resource mapping



findRootMappingByClass
public ResourceMapping findRootMappingByClass(Class clazz) throws MappingException(Code)
Finds a root mapping by the class name. If a root mapping is not found for the class name, than searches for mappings for the interfaces, if not found, checks for subclasses, and subclassess interfaces. Note: If there is no direct mapping that match the class name, then the mapping that is found should be marked as poly.
Parameters:
  clazz - The class to find root mapping for The resource mapping



getAliasMapping
public AliasMapping getAliasMapping(String alias)(Code)
Returns the alias mapping for the given alias (most if not all of the times, this will be a org.compass.core.mapping.ResourceMapping ).



getAllDirectMappingByClass
public List<ResourceMapping> getAllDirectMappingByClass(Class clazz)(Code)
Returns all the direct class mapping for the given class (root or not). Will not try to navigate up the interface/superclass in order to find the "nearest" class mapping.



getConverterLookup
public ConverterLookup getConverterLookup()(Code)



getDirectMappingByClass
public ResourceMapping getDirectMappingByClass(Class clazz)(Code)
Returns the direct class mapping for the given class (root or not). Will not try to navigate up the interface/superclass in order to find the "nearset" class mapping.

If a class has more than one mappings (using differnet aliases) will return the first one.




getMappingByAlias
public ResourceMapping getMappingByAlias(String alias)(Code)
Returns the resource mapping for the given alias.



getMappingByClass
public ResourceMapping getMappingByClass(Class clazz)(Code)
Finds the Resource mapping that is the "nearest" to the provided class. Similar way that CompassMapping.findRootMappingByClass(Class) except the search is on all the ClassMappings (even ones that are not marked as root).



getNonRootMappingByAlias
public ResourceMapping getNonRootMappingByAlias(String alias)(Code)
Returns the non root resource mapping associated with the alias. Retruns null if no non root mapping (or no mapping) is associated with the alias.



getNonRootMappingByClass
public ResourceMapping getNonRootMappingByClass(Class clazz) throws MappingException(Code)
Does exactly the same as CompassMapping.findNonRootMappingByClass(Class) , but returns null if nothing is found (does not throw an exception).



getPath
public PropertyPath getPath()(Code)



getResourcePropertyLookup
public ResourcePropertyLookup getResourcePropertyLookup(String name) throws IllegalArgumentException(Code)
Returns a resoruce lookup for a specific name. Supports dot path notation ([alias].[class property].). Allows to get the meta-data/resource property mapping through it (or a list of mappings).



getResourcePropertyMappingByPath
public ResourcePropertyMapping getResourcePropertyMappingByPath(String path)(Code)
Finds the ResourcePropertyMapping definition for the specified path. The path is in the format of: [alias].[class property mapping].[meta data mapping] in case of class mapping, and [alias].[resource property mapping] in case of resource mapping. The format of [alias].[class property mapping] can also be applied, and will result in the meta data id of the given class property mapping.
Parameters:
  path - the path to the resource property mapping the resource property mapping for the given path



getResourcePropertyMappingsByPath
public ResourcePropertyMapping[] getResourcePropertyMappingsByPath(String path)(Code)
Returns an array of all the given org.compass.core.mapping.ResourcePropertyMapping for the given path. If the path is in "dot path" notation, will reutrn a single mappings matching it (see CompassMapping.getResourcePropertyMappingByPath(String) ). Otherwise will return all the ones mapped to the given name.



getRootMappingByAlias
public ResourceMapping getRootMappingByAlias(String alias)(Code)
Returns the root resource mapping associated with the alias. Retruns null if no root mapping (or no mapping) is associated with the alias.



getRootMappingByClass
public ResourceMapping getRootMappingByClass(Class clazz) throws MappingException(Code)
Does exactly the same as CompassMapping.findRootMappingByClass(Class) , but returns null if nothing is found (does not throw an exception).



getRootMappings
public ResourceMapping[] getRootMappings()(Code)



hasMultipleRootClassMapping
public boolean hasMultipleRootClassMapping(String className)(Code)
Returns true if the given className has multiple class mappings.



hasRootClassMapping
public boolean hasRootClassMapping(String alias)(Code)
Returns true if there is a root org.compass.core.mapping.osem.ClassMapping for the given alias.



hasRootMappingByAlias
public boolean hasRootMappingByAlias(String alias)(Code)
Returns true if the given alias has a root resource mapping.



hasRootRawResourceMapping
public boolean hasRootRawResourceMapping(String alias)(Code)
Returns true if there is a root org.compass.core.mapping.rsem.RawResourceMapping for the given alias.



mappingsIt
public Iterator mappingsIt()(Code)
Returns an itertor over all the current mappings.



postProcess
public void postProcess()(Code)



setPath
public void setPath(PropertyPath path)(Code)



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
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.