Java Doc for Filter.java in  » GIS » GeoTools-2.4.1 » org » geotools » filter » 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 » GIS » GeoTools 2.4.1 » org.geotools.filter 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.geotools.filter.Filter

All known Subclasses:   org.geotools.filter.AbstractFilter,
Filter
public interface Filter extends FilterType,org.opengis.filter.Filter(Code)
Defines an OpenGIS Filter object, with default behaviors for all methods.
author:
   Rob Hranac, Vision for New York
version:
   $Id: Filter.java 22600 2006-11-04 09:37:58Z jgarnett $org.opengis.filter.Filter


Field Summary
final static  org.opengis.filter.FilterALL
    
final static  org.opengis.filter.FilterNONE
    


Method Summary
 voidaccept(FilterVisitor visitor)
     Used by FilterVisitors to perform some action on this filter instance. Typicaly used by Filter decoders, but may also be used by any thing which needs infomration from filter structure.
 Filterand(org.opengis.filter.Filter filter)
     Implements a logical AND with this filter and returns the merged filter.
Parameters:
  filter - The filter to AND with this filter.
 booleancontains(Feature feature)
     Determines whether or not a given feature is 'contained by' this filter.

This is the core function of any filter.

 booleanevaluate(Feature feature)
     Evaluates the filter against an instance of Feature .
Parameters:
  feature - The feature being tested.
 shortgetFilterType()
    
 Filternot()
    
 Filteror(org.opengis.filter.Filter filter)
     Implements a logical OR with this filter and returns the merged filter.
Parameters:
  filter - The filter to OR with this filter.

Field Detail
ALL
final static org.opengis.filter.Filter ALL(Code)



NONE
final static org.opengis.filter.Filter NONE(Code)





Method Detail
accept
void accept(FilterVisitor visitor)(Code)
Used by FilterVisitors to perform some action on this filter instance. Typicaly used by Filter decoders, but may also be used by any thing which needs infomration from filter structure. Implementations should always call: visitor.visit(this); It is importatant that this is not left to a parent class unless the parents API is identical.
Parameters:
  visitor - The visitor which requires access to this filter, themethod must call visitor.visit(this);org.opengis.filter.Filter.accept(FilterVisitorObject)



and
Filter and(org.opengis.filter.Filter filter)(Code)
Implements a logical AND with this filter and returns the merged filter.
Parameters:
  filter - The filter to AND with this filter. Combined filter.



contains
boolean contains(Feature feature)(Code)
Determines whether or not a given feature is 'contained by' this filter.

This is the core function of any filter. 'Contains' isn't a very good term for this method because it implies some sort of spatial relationship between the feature and the filter that may or may not exist. We name this method 'contains' only because the usage of 'contains' in this context is common and better terms are lacking. However, users of this method should keep in mind the non-spatial nature of this meaning of 'contains.' For example, a feature may be 'contained by' a filter if one of the feature's non-spatial property values is equal to that of the filter's.

Although some filters can be checked for validity when they are constructed, it is impossible to impose this check on all expressions because of a special feature of the ExpressionAttribute class. This class must hold the pointer (in XPath) to an attribute, but it is not passed the actual attribute (inside a feature) until it calls the isInside class.

To avoid a run-time Exception, this class is typed (ie. Double, Integer, String) when it is created. If the attribute found inside the feature is found not to conform with its stated type, then a MalformedExpressionException is thrown when contains is called. Since ExpressionAttribute classes may be nested inside any filter, all filters must throw this exception. It is left to callers of this method to deal with it gracefully.


Parameters:
  feature - Specified feature to examine. True if filter contains passed feature.Filter.evaluate(Feature)



evaluate
boolean evaluate(Feature feature)(Code)
Evaluates the filter against an instance of Feature .
Parameters:
  feature - The feature being tested. True if the feature is filtered, otherwise false.



getFilterType
short getFilterType()(Code)
DOCUMENT ME! DOCUMENT ME!



not
Filter not()(Code)
Implements a logical NOT with this filter and returns the negated filter Combined filter.



or
Filter or(org.opengis.filter.Filter filter)(Code)
Implements a logical OR with this filter and returns the merged filter.
Parameters:
  filter - The filter to OR with this filter. Combined filter.



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