Java Doc for MapStringExpression.java in  » Report » pentaho-report » org » jfree » report » function » strings » 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 » Report » pentaho report » org.jfree.report.function.strings 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jfree.report.function.AbstractExpression
      org.jfree.report.function.strings.MapStringExpression

MapStringExpression
public class MapStringExpression extends AbstractExpression (Code)
Maps a string read from a column into an other string. The possible mappings are given as (key, text) pairs. If the string from the column is null or matches none of the defined keys, a fallback value is returned. If the fallback value is undefined, the original value is returned instead.
author:
   Thomas Morgner



Constructor Summary
public  MapStringExpression()
     Default Constructor.

Method Summary
public  StringgetFallbackValue()
     Returns the value that is returned if none of the predefined keys matches the lookup-value.
public  StringgetField()
     Returns the name of the field from where to read the key value.
public  ExpressiongetInstance()
     Return a completly separated copy of this function.
public  StringgetKey(int index)
     Returns a key value at the given index.
Parameters:
  index - the index position of the key in the list.
public  String[]getKey()
     Returns all defined keys as string array.
public  intgetKeyCount()
     Returns the number of keys defined in the expression.
public  StringgetNullValue()
     Returns the value that is returned if the key-field evaluates to null.
public  StringgetText(int index)
     Returns the mapped text for the key at the given position.
public  String[]getText()
     Returns all defined texts as string-array.
public  intgetTextCount()
     Returns the number of replacement text defined in this expression.
public  ObjectgetValue()
     Performs the lookup by first querying the given field, and then returning the defined text for the key-position.
public  booleanisIgnoreCase()
     Returns, whether the key-lookup should be case-insensitive.
public  voidsetFallbackValue(String fallbackValue)
     Defines the value that is returned if none of the predefined keys matches the lookup-value.
public  voidsetField(String field)
     Defines the name of the field from where to read the key value.
public  voidsetIgnoreCase(boolean ignoreCase)
     Defines, whether the key-lookup should be case-insensitive.
public  voidsetKey(int index, String key)
     Defines a key value to which the lookup-field's value is compared.
public  voidsetKey(String[] keys)
     Defines all keys using the values from the string array.
public  voidsetNullValue(String nullValue)
     Defines the value that is returned if the key-field evaluates to null.
public  voidsetText(int index, String value)
     Defines the mapped text for the key at the given position.
public  voidsetText(String[] texts)
     Defines all texts by using the values from the given text-array.


Constructor Detail
MapStringExpression
public MapStringExpression()(Code)
Default Constructor.




Method Detail
getFallbackValue
public String getFallbackValue()(Code)
Returns the value that is returned if none of the predefined keys matches the lookup-value. the fallback value.



getField
public String getField()(Code)
Returns the name of the field from where to read the key value. the field name.



getInstance
public Expression getInstance()(Code)
Return a completly separated copy of this function. The copy does no longer share any changeable objects with the original function. a copy of this function.



getKey
public String getKey(int index)(Code)
Returns a key value at the given index.
Parameters:
  index - the index position of the key in the list. the key value.



getKey
public String[] getKey()(Code)
Returns all defined keys as string array. all defined keys.



getKeyCount
public int getKeyCount()(Code)
Returns the number of keys defined in the expression. the number of keys.



getNullValue
public String getNullValue()(Code)
Returns the value that is returned if the key-field evaluates to null. the null-value.



getText
public String getText(int index)(Code)
Returns the mapped text for the key at the given position. This text is returned if the key matches the value read from the lookup-field column.
Parameters:
  index - the index of the entry. the text that is returned if the key is selected.



getText
public String[] getText()(Code)
Returns all defined texts as string-array. all texts.



getTextCount
public int getTextCount()(Code)
Returns the number of replacement text defined in this expression. This should match the number of keys defined. the number of texts defined.



getValue
public Object getValue()(Code)
Performs the lookup by first querying the given field, and then returning the defined text for the key-position. the value of the function.



isIgnoreCase
public boolean isIgnoreCase()(Code)
Returns, whether the key-lookup should be case-insensitive. true, if the key comparison is case-insensitive, false otherwise.



setFallbackValue
public void setFallbackValue(String fallbackValue)(Code)
Defines the value that is returned if none of the predefined keys matches the lookup-value.
Parameters:
  fallbackValue - the fallback value.



setField
public void setField(String field)(Code)
Defines the name of the field from where to read the key value.
Parameters:
  field - the field name.



setIgnoreCase
public void setIgnoreCase(boolean ignoreCase)(Code)
Defines, whether the key-lookup should be case-insensitive.
Parameters:
  ignoreCase - true, if the key comparison is case-insensitive, false otherwise.



setKey
public void setKey(int index, String key)(Code)
Defines a key value to which the lookup-field's value is compared. If the key is defined, a matching value must be defined too.
Parameters:
  index - the index position of the key in the list.
Parameters:
  key - the key value.



setKey
public void setKey(String[] keys)(Code)
Defines all keys using the values from the string array.
Parameters:
  keys - all defined keys.



setNullValue
public void setNullValue(String nullValue)(Code)
Defines the value that is returned if the key-field evaluates to null.
Parameters:
  nullValue - the null-value.



setText
public void setText(int index, String value)(Code)
Defines the mapped text for the key at the given position. This text is returned if the key matches the value read from the lookup-field column.
Parameters:
  index - the index of the entry.
Parameters:
  value - the text that is returned if the key is selected.



setText
public void setText(String[] texts)(Code)
Defines all texts by using the values from the given text-array.
Parameters:
  texts - the new text-values.



Methods inherited from org.jfree.report.function.AbstractExpression
public Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public DataRow getDataRow()(Code)(Java Doc)
public int getDependencyLevel()(Code)(Java Doc)
public Expression getInstance()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
public Configuration getReportConfiguration()(Code)(Java Doc)
public ResourceBundleFactory getResourceBundleFactory()(Code)(Java Doc)
public ExpressionRuntime getRuntime()(Code)(Java Doc)
final public boolean isActive()(Code)(Java Doc)
public boolean isDeepTraversing()(Code)(Java Doc)
public boolean isPreserve()(Code)(Java Doc)
final public void setActive(boolean active)(Code)(Java Doc)
public void setDependencyLevel(int level)(Code)(Java Doc)
public void setName(String name)(Code)(Java Doc)
public void setPreserve(boolean preserve)(Code)(Java Doc)
public void setRuntime(ExpressionRuntime runtime)(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.