Java Doc for Gateway.java in  » ERP-CRM-Financial » SourceTap-CRM » org » ofbiz » rules » engine » 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 » ERP CRM Financial » SourceTap CRM » org.ofbiz.rules.engine 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.ofbiz.rules.engine.Structure
      org.ofbiz.rules.engine.Gateway

All known Subclasses:   org.ofbiz.rules.engine.Comparison,  org.ofbiz.rules.engine.ConsultingNot,  org.ofbiz.rules.engine.Evaluation,
Gateway
abstract public class Gateway extends Structure (Code)

Title: Gateway

Description: None

Copyright (c) 1999 Steven J. Metsker.

Copyright (c) 2001 The Open For Business Project - www.ofbiz.org

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

A Gateway is a structure that can prove its truth at most once before failing.

Examples of gateways are comparisons, negations, and mathematical evaluations. For example, Age > 18 is either true or not, it cannot prove itself in more than one way. Also, not married(X) is true only if the structure married(X) cannot prove itself at all.

The fact that gateways can be true only once is important in rules. For example, a rule might contain:

 ..., plays(jim, Game, Rating),
 Rating >= 7, likes(jane, Game), ...
 
As this rule proves itself, if it finds a game that Jim plays with a rating of, say, 8, the rule will accept that Rating >= 7. The rule will then proceed to prove the structures after the comparison. The rule may succeed with the latter structures many times, but eventually these structures will run out of proofs, and the rule will fail back to the comparison structure.

On failing back, the rule will ask the comparison for its next proof. This amounts to asking if there is a different way to prove that 8 is greater than or equal to 7. Since the comparison has already succeeded once, which allowed the rule to check the latter structures, on failing back the comparison will fail. This will cause the rule to fail back to the preceding plays structure, which may be able to find other proofs.

If a preceding structure succeeds, the rule will move forward again, and ask a gateway to prove itself. Since the gateway has failed, it will try again to prove itself.
author:
   Steven J. Metsker
version:
   1.0



Field Summary
protected  booleanopen
     If this structure is involved in a proof, the gate is open and will shut when the rule fails back to this structure.

Constructor Summary
protected  Gateway(Object functor, Term[] terms)
     Allows subclasses to use this form of constructor.

Method Summary
public  booleancanFindNextProof()
     Returns true if the gate is closed and this gateway can find a new proof.

A gateway is a structure that can prove itself in at most one way.

public  booleancanProveOnce()
     Returns true if the comparison operator holds true between each pair of terms.

This method recovers the comparison operator from the Token which is the functor for this Comparison.

protected  voidcleanup()
     Insert the method's description here.

Field Detail
open
protected boolean open(Code)
If this structure is involved in a proof, the gate is open and will shut when the rule fails back to this structure.




Constructor Detail
Gateway
protected Gateway(Object functor, Term[] terms)(Code)
Allows subclasses to use this form of constructor. This typically happens when the subclass object is creating an executable copy of itself.
Parameters:
  functor - the functor for this gateway
Parameters:
  terms - the terms of the gateway
Parameters:
  program - the program the gateway will prove itselfagainst




Method Detail
canFindNextProof
public boolean canFindNextProof()(Code)
Returns true if the gate is closed and this gateway can find a new proof.

A gateway is a structure that can prove itself in at most one way. After a successful proof, a gateway leaves its gate open.

If the gate is open when this method executes, this method will shut the gate and return false. This occurs after a gateway has proven itself true once, and a rule has failed back to the point where it is asking the gateway for another proof.

If the gate is not open, this gateway will try to prove itself. Then,

  • If the gate is not open and this gateway can prove itself, then this method will return true and leave the gate open. Returning true allows the containing rule to go on to prove whatever structures follow this one. When the rule fails back to this gateway, the gate will be open, and at that time this gateway will fail.

  • If the gate is not open and this gateway can not prove itself, this method returns false.

Upon leaving the gate closed, this method unbinds any variables that instantiated as part of this gateway's proof. This method also sets rule checking to begin again at the first program rule, upon the next request for a proof sent to this gateway.
Parameters:
  depth - the depth at which to print tracing information true if the gate is closed and this gateway can find anew proof




canProveOnce
public boolean canProveOnce()(Code)
Returns true if the comparison operator holds true between each pair of terms.

This method recovers the comparison operator from the Token which is the functor for this Comparison. This method applies this comparison to each pair of terms. That is, this method compares term 0 with term 1, term 1 with term 2, term 2 with term 3, and so on. This method returns true if the comparison holds between each adjacent pair of terms.

If a term is a variable, this method uses the term's ground value in the comparison.
Parameters:
  depth - the depth at which to print trace information




cleanup
protected void cleanup()(Code)
Insert the method's description here. Creation date: (12/7/99 11:09:44 AM)



Fields inherited from org.ofbiz.rules.engine.Structure
final public static EmptyList emptyList(Code)(Java Doc)
protected Object functor(Code)(Java Doc)
protected Term[] terms(Code)(Java Doc)

Methods inherited from org.ofbiz.rules.engine.Structure
public int arity()(Code)(Java Doc)
public boolean canFindNextProof()(Code)(Java Doc)
public Term copyForProof(AxiomSource as, Scope scope)(Code)(Java Doc)
public boolean equals(Object o)(Code)(Java Doc)
public Object eval()(Code)(Java Doc)
public boolean functorAndArityEquals(Structure s)(Code)(Java Doc)
protected static Term[] headAndTail(Term[] terms, Term tail)(Code)(Java Doc)
public boolean isList()(Code)(Java Doc)
public static Structure list(Object[] objects)(Code)(Java Doc)
public static Structure list(Term[] terms)(Code)(Java Doc)
public static Structure list(Term[] terms, Term tail)(Code)(Java Doc)
public String listTailString()(Code)(Java Doc)
protected String listTermsToString()(Code)(Java Doc)
public Term[] terms()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public Unification unify(Structure s)(Code)(Java Doc)
public Unification unify(Term t)(Code)(Java Doc)
public Unification unify(Variable v)(Code)(Java Doc)
public Unification variables()(Code)(Java Doc)

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.