org.apache.uima.tools.cpm
Class ConfigField

java.lang.Object
  extended by org.apache.uima.tools.cpm.ConfigField

public class ConfigField
extends java.lang.Object

Configuration Field class used for representation of resource parameters in dynamically created MetaDataPanels.

See Also:
MetaDataPanel

Constructor Summary
ConfigField(java.lang.String pn, java.lang.String cs, boolean mv, javax.swing.JComponent c)
           
 
Method Summary
 void clearDirty()
          To be called when the CPE descriptor is saved.
 java.lang.String getClassString()
           
 javax.swing.JComponent getFieldComponent()
           
 java.lang.Object getFieldValue()
           
 java.lang.String getParameterName()
           
 boolean isDirty()
          Returns whether this field has been modified since the last time the CPE descriptor was saved.
 boolean isModified()
          Returns whether this field has been modified from its original value.
 boolean isMultiValued()
           
 void setFieldValue(java.lang.Object fieldValue)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConfigField

public ConfigField(java.lang.String pn,
                   java.lang.String cs,
                   boolean mv,
                   javax.swing.JComponent c)
Parameters:
pn - Resource parameter name e.g. outputDir
cs - String value of Java type used for value e.g. Integer
mv - true if the value is a multi-value array
c - Component used to represent field - Could be JTextField, JCheckBox, FileSelector or ListSelector
Method Detail

getParameterName

public java.lang.String getParameterName()

getClassString

public java.lang.String getClassString()

getFieldComponent

public javax.swing.JComponent getFieldComponent()

isMultiValued

public boolean isMultiValued()

getFieldValue

public java.lang.Object getFieldValue()

setFieldValue

public void setFieldValue(java.lang.Object fieldValue)

isModified

public boolean isModified()
Returns whether this field has been modified from its original value. This is not affected by whether the user has saved the new value; for that use isDirty().


isDirty

public boolean isDirty()
Returns whether this field has been modified since the last time the CPE descriptor was saved.


clearDirty

public void clearDirty()
To be called when the CPE descriptor is saved. Sets this field to be not dirty, until it is next modified.



Copyright © 2010 The Apache Software Foundation. All Rights Reserved.