Examples of org.apache.uima.resource.metadata.ConfigurationParameter

Package org.apache.uima.resource.metadata

Examples of org.apache.uima.resource.metadata.ConfigurationParameter

org.apache.uima.resource.metadata.ConfigurationParameter
Completely specifies a configuration parameter on a UIMA resource.
A configuration parameter consists of the following fields:
- Name
- Description
- Type (String, Boolean, Integer, or Float)
- Is the parameter multi-valued?
- Is a value mandatory?
- Overrides (see below)
This interface does not provide access to the value of the parameter - that is a separate piece of metadata associated with the resource.
In an aggregate resource, configuration parameters may override component resources' parameters. This is done by the {@link #getOverrides() overrides} property. Overrides should always bespecified for aggregate resources. If no overrides are specified, the default behavior is to override any parameter with the same name in any component resource. However, this usage is discouraged and will generate a warning in the log file; it exists for backwards compatibility purposes.
As with all {@link MetaDataObject}s, a ConfigurationParameter may or may not be modifiable. An application can find out by calling the {@link #isModifiable()} method.

    dialog.description = modelParm.getDescription();
    dialog.mandatory = modelParm.isMandatory();
    dialog.multiValue = modelParm.isMultiValued();
    dialog.parmType = modelParm.getType();
    // dialog.overrideSpec = override;
    ConfigurationParameter parmInGroup = addNewConfigurationParameter(dialog, parentGroup);
    addOverride(parmInGroup, override);
    parentGroup.setExpanded(true);
    commonActionFinish();
  }

View Full Code Here

    commonActionFinish();
  }


  private void alterExistingConfigurationParameter(AddParameterDialog dialog,
          TreeItem existingTreeItem) {
    ConfigurationParameter existingCP = getCorrespondingModelParm(existingTreeItem);
    ConfigurationParameter previousCP = existingCP;
    previousCP = (ConfigurationParameter) previousCP.clone();
    fillModelParm(dialog, existingCP);
    fillParmItem(existingTreeItem, existingCP);


    // the following may have changed in an existing param spec, that could
    // affect the setting:
    // 1) the name, 2) the type, 3) the multi-value aspect
    // Description or mandatory changes have no effect on the settings


    // If the multi-value aspect changes, drop all the settings
    // If the type changes, drop all the settings
    // If the name changes, change existing settings for that parm name in all groups


    if ((!previousCP.getType().equals(existingCP.getType()))
            || (previousCP.isMultiValued() != existingCP.isMultiValued())) {
      removeParmSettingFromMultipleGroups(existingTreeItem, !REMOVE_FROM_GUI);
    }


    commonParmUpdate(existingTreeItem, existingCP, previousCP.getName());
  }

View Full Code Here

   * @param group
   * @return
   */
  private ConfigurationParameter addNewConfigurationParameter(AddParameterDialog dialog,
          TreeItem group) {
    ConfigurationParameter newCP = new ConfigurationParameter_impl();
    fillModelParm(dialog, newCP);


    if (null != group) {
      String groupName = getName(group.getText());
      if (groupName.equals(COMMON_GROUP)) {

View Full Code Here

    ConfigGroup group = getCorrespondingModelGroup(delegateGroup);


    if (null == group) {
      group = parmSection.addGroup(delegateGroup);
    }
    ConfigurationParameter parmInGroup;
    String override = key + "/" + parm.getName();
    String overrideParmName;
    if (null != (overrideParmName = getOverridingParmName(override, cpd))) {
      Utility.popMessage("Only one override allowed",
              "This delegate parameter already is being overridden by '" + overrideParmName

View Full Code Here


  private void testConfigurationParameter(AnalysisEngineDescription aed, String parameterName,
          String parameterType, boolean mandatory, boolean multiValued, Object parameterValue) {
    ConfigurationParameterDeclarations cpd = aed.getMetaData()
            .getConfigurationParameterDeclarations();
    ConfigurationParameter cp = cpd.getConfigurationParameter(null, parameterName);
    assertNotNull("Parameter [" + parameterName + "] does not exist!", cp);
    assertEquals("Parameter [" + parameterName + "] has wrong name", parameterName, cp.getName());
    assertEquals("Parameter [" + parameterName + "] has wrong type", parameterType, cp.getType());
    assertEquals("Parameter [" + parameterName + "] has wrong mandatory flag", mandatory,
            cp.isMandatory());
    assertEquals("Parameter [" + parameterName + "] has wrong multi-value flag", multiValued,
            cp.isMultiValued());
    ConfigurationParameterSettings cps = aed.getMetaData().getConfigurationParameterSettings();
    Object actualValue = cps.getParameterValue(parameterName);
    if (parameterValue == null) {
      assertNull(actualValue);
    } else if (!multiValued) {

View Full Code Here


    return desc;
  }
  
  public static ConfigurationParameter findConfigurationParameter(ConfigurationParameterDeclarations configurationParameterDeclarations, String name) {
    ConfigurationParameter retVal = null;
    for (ConfigurationParameter parameter : configurationParameterDeclarations.getConfigurationParameters()) {
      if (name.equals(parameter.getName())) {
        retVal = parameter;
        break;
      }

View Full Code Here

   *            - aggregate ConfigurationParameterDeclarations instance
   */
  private static void addParam(String key, String[] nvp,
      ConfigurationParameter parameter,
      ConfigurationParameterDeclarations aggregateDeclarations) {
    ConfigurationParameter cfgParam = new ConfigurationParameter_impl();
    cfgParam.setName(nvp[0]);
    if (parameter == null) { // component descriptor doesnt contain a
                  // parameter provided in the override list.
                  // Default to String
      cfgParam.setType("String"); // create String param as default
    } else {
      cfgParam.setType(parameter.getType());
    }
//    if ( key.equals(FlowControllerKey)) {
//      cfgParam.addOverride(key + "/ActionAfterCasMultiplier");
//    } else {
//      cfgParam.addOverride(key + "/" + nvp[0]);
//    }
    cfgParam.addOverride(key + "/" + nvp[0]);
    aggregateDeclarations.addConfigurationParameter(cfgParam);


  }

View Full Code Here

            for (Entry<String, String> ent : map.entrySet()) {
                String name = ent.getKey();
                String value = ent.getValue();
                String message = "config param: "+name+" = '"+value+"'";
                mh.frameworkDebug(cid, mid, message);
                ConfigurationParameter configurationParameter = UimaUtils.findConfigurationParameter(configurationParameterDeclarations, name);
                if (configurationParameter == null) {
                    throw new ResourceConfigurationException(
                                    ResourceConfigurationException.NONEXISTENT_PARAMETER, new Object[] { name, "CollectionReader" });
                }
                Object object = UimaUtils.getOverrideValueObject(configurationParameter, value);

View Full Code Here

            Map<String,String> map = QuotedOptions.parseAssignments(toks, false);
            for (Entry<String, String> ent : map.entrySet()) {
                String name = ent.getKey();
                String value = ent.getValue();
                duccOut.debug(location, job.getDuccId(), "config param name:"+name+" "+"value:"+value);
                ConfigurationParameter configurationParameter = UimaUtils.findConfigurationParameter(configurationParameterDeclarations, name);
                if (configurationParameter == null) {
                    throw new ResourceConfigurationException(
                                    ResourceConfigurationException.NONEXISTENT_PARAMETER, new Object[] { name, "CollectionReader" });
                }
                Object object = UimaUtils.getOverrideValueObject(configurationParameter, value);

View Full Code Here

      AnalysisEngineDescription primitiveDesc = new AnalysisEngineDescription_impl();
      primitiveDesc.setPrimitive(true);
      primitiveDesc.getMetaData().setName("Test Primitive TAE");
      primitiveDesc
              .setAnnotatorImplementationName("org.apache.uima.analysis_engine.impl.TestAnnotator");
      ConfigurationParameter p1 = new ConfigurationParameter_impl();
      p1.setName("StringParam");
      p1.setDescription("parameter with String data type");
      p1.setType(ConfigurationParameter.TYPE_STRING);
      primitiveDesc.getMetaData().getConfigurationParameterDeclarations()
              .setConfigurationParameters(new ConfigurationParameter[] { p1 });
      primitiveDesc.getMetaData().getConfigurationParameterSettings().setParameterSettings(
              new NameValuePair[] { new NameValuePair_impl("StringParam", "Test1") });


      // instantiate TextAnalysisEngine
      PrimitiveAnalysisEngine_impl ae = new PrimitiveAnalysisEngine_impl();
      ae.initialize(primitiveDesc, null);


      // check value of string param (TestAnnotator saves it in a static field)
      assertEquals("Test1", TestAnnotator.stringParamValue);


      // reconfigure
      ae.setConfigParameterValue("StringParam", "Test2");
      ae.reconfigure();


      // test again
      assertEquals("Test2", TestAnnotator.stringParamValue);


      // test aggregate TAE
      AnalysisEngineDescription aggDesc = new AnalysisEngineDescription_impl();
      aggDesc.setFrameworkImplementation(Constants.JAVA_FRAMEWORK_NAME);
      aggDesc.setPrimitive(false);
      aggDesc.getMetaData().setName("Test Aggregate TAE");
      aggDesc.getDelegateAnalysisEngineSpecifiersWithImports().put("Test", primitiveDesc);
      FixedFlow_impl flow = new FixedFlow_impl();
      flow.setFixedFlow(new String[] { "Test" });
      aggDesc.getAnalysisEngineMetaData().setFlowConstraints(flow);
      ConfigurationParameter p2 = new ConfigurationParameter_impl();
      p2.setName("StringParam");
      p2.setDescription("parameter with String data type");
      p2.setType(ConfigurationParameter.TYPE_STRING);
      aggDesc.getMetaData().getConfigurationParameterDeclarations().setConfigurationParameters(
              new ConfigurationParameter[] { p2 });
      aggDesc.getMetaData().getConfigurationParameterSettings().setParameterSettings(
              new NameValuePair[] { new NameValuePair_impl("StringParam", "Test3") });
      // instantiate TextAnalysisEngine
      AggregateAnalysisEngine_impl aggAe = new AggregateAnalysisEngine_impl();
      aggAe.initialize(aggDesc, null);


      assertEquals("Test3", TestAnnotator.stringParamValue);


      // reconfigure
      aggAe.setConfigParameterValue("StringParam", "Test4");
      aggAe.reconfigure();


      // test again
      assertEquals("Test4", TestAnnotator.stringParamValue);


      // reconfigure WITHOUT setting that parameter
      aggAe.reconfigure();
      // test again
      assertEquals("Test4", TestAnnotator.stringParamValue);


      // test aggregate TAE that does NOT override parameter
      primitiveDesc.getMetaData().getConfigurationParameterSettings().setParameterSettings(
              new NameValuePair[] { new NameValuePair_impl("StringParam", "Test1") });
      AnalysisEngineDescription aggDesc2 = new AnalysisEngineDescription_impl();
      aggDesc2.setFrameworkImplementation(Constants.JAVA_FRAMEWORK_NAME);
      aggDesc2.setPrimitive(false);
      aggDesc2.getMetaData().setName("Test Aggregate TAE");
      aggDesc2.getDelegateAnalysisEngineSpecifiersWithImports().put("Test", primitiveDesc);
      FixedFlow_impl flow2 = new FixedFlow_impl();
      flow2.setFixedFlow(new String[] { "Test" });
      aggDesc2.getAnalysisEngineMetaData().setFlowConstraints(flow2);
      ConfigurationParameter p3 = new ConfigurationParameter_impl();
      p3.setName("IntParam");
      p3.setDescription("parameter with Integer data type");
      p3.setType(ConfigurationParameter.TYPE_INTEGER);
      aggDesc2.getMetaData().getConfigurationParameterDeclarations().setConfigurationParameters(
              new ConfigurationParameter[] { p3 });
      aggDesc2.getMetaData().getConfigurationParameterSettings().setParameterSettings(
              new NameValuePair[] { new NameValuePair_impl("IntParam", Integer.valueOf(42)) });
      // instantiate TextAnalysisEngine

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.apache.uima.resource.metadata.ConfigurationParameter

org.apache.uima.aae.controller.PrimitiveAnalysisEngineController_impl

org.apache.uima.analysis_engine.impl.AnalysisEngine_implTest

org.apache.uima.analysis_engine.impl.AnalysisEngineDescription_impl

org.apache.uima.analysis_engine.impl.AnalysisEngineDescription_implTest

org.apache.uima.analysis_engine.impl.MultiprocessingAnalysisEngine_implTest

org.apache.uima.analysis_engine.impl.TaeDescription_implTest

org.apache.uima.collection.impl.CasConsumerDescription_implTest

org.apache.uima.collection.impl.CasInitializerDescription_implTest

org.apache.uima.collection.impl.CollectionReaderDescription_implTest

org.apache.uima.collection.impl.cpm.container.CPEFactory

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.