Java Doc for AbstractFunction.java in  » Database-ORM » MMBase » org » mmbase » util » functions » 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 » Database ORM » MMBase » org.mmbase.util.functions   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.mmbase.util.functions.AbstractFunction AbstractFunction abstract public class AbstractFunction implements Function<R>,Comparable<Function<R>>,java.io.Serializable(Code) An abstract representation of a piece of functionality (a 'function'). A function has a name, a return type, and a parameter-definition (which is a Parameter array). The goal of a Function object is to call its AbstractFunction.getFunctionValue(Parameters) method, which executes it, given the specified parameters. author:    Daniel Ockeloen author:    Michiel Meeuwissen version:    $Id: AbstractFunction.java,v 1.20 2007/06/21 15:50:21 nklasens Exp $ since:    MMBase-1.8 See Also:   Parameter See Also:   Parameters Field Summary protected  boolean autoReturnType      protected  String name      protected  ReturnType<R> returnType      Constructor Summary public   AbstractFunction(String name, Parameter[] def, ReturnType<R> returnType)      Constructor for Function objects. Parameters:   name - Every function must have a name Parameters:   def - Every function must have a parameter definition. public   AbstractFunction(String name, Parameter... def)      Determines the ReturnType automaticly using the return type of AbstractFunction.getFunctionValue(Parameters) . Method Summary public  int compareTo(Function<R> fun)      public  Parameters createParameters()      public  boolean equals(Object o)      public  String getDescription()      abstract public  R getFunctionValue(Parameters parameters)      Executes the defined function supplying the given arguments. See Also:   AbstractFunction.createParameters Parameters:   parameters - The parameters for the function. final public  R getFunctionValue(Object... parameters)      final public  R getFunctionValueWithList(List parameters)      Executes the defined function supplying the given List of arguments. This is a convenience method, as the List is mapped to a Parameters type and passed to AbstractFunction.getFunctionValue(Parameters) . Parameters:   parameters - The parameters for the function. public  String getName()      A function must have a name. public  Parameter[] getParameterDefinition()      public  ReturnType<R> getReturnType()      public  int hashCode()      public  void setDescription(String description)      For documentational purposes a function object needs a description too. public  void setParameterDefinition(Parameter[] params)      A function object is of no use, as long as it lacks a definition. public  void setReturnType(ReturnType<R> type)      Sets the ReturnType for this function if not set already. Parameters:   type - A ReturnType object. public  String toString()      Field Detail autoReturnType protected boolean autoReturnType(Code) name protected String name(Code) returnType protected ReturnType<R> returnType(Code) Constructor Detail AbstractFunction public AbstractFunction(String name, Parameter[] def, ReturnType<R> returnType)(Code) Constructor for Function objects. Parameters:   name - Every function must have a name Parameters:   def - Every function must have a parameter definition. It can be left null and then filled later by AbstractFunction.setParameterDefinition Parameters:   returnType - Every function must also specify its return type. It can be left null and then filled later by AbstractFunction.setReturnType AbstractFunction public AbstractFunction(String name, Parameter... def)(Code) Determines the ReturnType automaticly using the return type of AbstractFunction.getFunctionValue(Parameters) . since:    MMBase-1.9 Method Detail compareTo public int compareTo(Function<R> fun)(Code) createParameters public Parameters createParameters()(Code) Creates an empty 'Parameters' object for you, which you have to fill and feed back to getFunctionValue See Also:   AbstractFunction.getFunctionValue(Parameters) equals public boolean equals(Object o)(Code) getDescription public String getDescription()(Code) See Also:   AbstractFunction.setDescription(String) getFunctionValue abstract public R getFunctionValue(Parameters parameters)(Code) Executes the defined function supplying the given arguments. See Also:   AbstractFunction.createParameters Parameters:   parameters - The parameters for the function. To specify an empty parameter list use Parameters.VOID.Implementors are encouraged to support null too. The function value, which can be of any type compatible to AbstractFunction.getReturnType getFunctionValue final public R getFunctionValue(Object... parameters)(Code) since:    MMBase-1.9 getFunctionValueWithList final public R getFunctionValueWithList(List parameters)(Code) Executes the defined function supplying the given List of arguments. This is a convenience method, as the List is mapped to a Parameters type and passed to AbstractFunction.getFunctionValue(Parameters) . Parameters:   parameters - The parameters for the function. To specify an empty parameter list use Parameters.VOID. The function value, which can be of any type compatible to AbstractFunction.getReturnType getName public String getName()(Code) A function must have a name. This is the name which was used to aquire the function object. The function's name, never null getParameterDefinition public Parameter[] getParameterDefinition()(Code) The currently set Parameter definition array, or null if not set already. getReturnType public ReturnType<R> getReturnType()(Code) The currently set ReturnType, or null if not set already. hashCode public int hashCode()(Code) See Also:   java.lang.Object.hashCode setDescription public void setDescription(String description)(Code) For documentational purposes a function object needs a description too. setParameterDefinition public void setParameterDefinition(Parameter[] params)(Code) A function object is of no use, as long as it lacks a definition. Parameters:   params - An array of Parameter objects. throws:   IllegalStateException - if there was already set a parameter defintion for this function object. setReturnType public void setReturnType(ReturnType<R> type)(Code) Sets the ReturnType for this function if not set already. Parameters:   type - A ReturnType object. For void functions that could be ReturnType.VOID. throws:   IllegalStateException - if there was already set a return type for this function object. toString public String toString()(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)