Skip to content

Commit

Permalink
Issue #387: Simplify creation of new UIMAContext
Browse files Browse the repository at this point in the history
- Added builder
- Added another factory method without any arguments for the simplest case
- Deprecated old factory method
- Deprecated three-args init method in UimaContextAdmin and added a replacement default method to the interface
  • Loading branch information
reckart committed Sep 5, 2024
1 parent 5fc9ec9 commit caeb6b4
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 1 deletion.
13 changes: 12 additions & 1 deletion uimaj-core/src/main/java/org/apache/uima/UIMAFramework.java
Original file line number Diff line number Diff line change
Expand Up @@ -1088,7 +1088,10 @@ public static ConfigurationManager newConfigurationManager() {
* Parameter settings.
*
* @return a new UIMA Context to be used by the application.
* @deprecated Use {@link #newUimaContext()} or {@link #uimaContextBuider()} instead.
* @forRemoval 4.0.0
*/
@Deprecated(since = "3.6.0")
public static UimaContextAdmin newUimaContext(Logger aLogger, ResourceManager aResourceManager,
ConfigurationManager aConfigManager) {
// We use an ugly trick to make the 3 values available to the new UIMA context during its
Expand All @@ -1103,10 +1106,18 @@ public static UimaContextAdmin newUimaContext(Logger aLogger, ResourceManager aR
newContextResourceManager.set(null);
newContextConfigManager.set(null);
}
context.initializeRoot(aLogger, aResourceManager, aConfigManager);
context.initializeRoot(aLogger);
return context;
}

public static UimaContextAdmin newUimaContext() {
return uimaContextBuider().build();
}

public static UimaContextAdminBuilder uimaContextBuider() {
return new UimaContextAdminBuilder();
}

/**
* Gets the default performance tuning settings for the framework. Advanced users can tweak the
* framework by modifying these properties and passing the modified Properties object into the
Expand Down
13 changes: 13 additions & 0 deletions uimaj-core/src/main/java/org/apache/uima/UimaContextAdmin.java
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,16 @@
* interface. The methods on this interface are for the framework's use only. *
*/
public interface UimaContextAdmin extends UimaContext {
/**
* Initializes a root UimaContext.
*
* @param aLogger
* the logger that will be returned by this UimaContext's {@link #getLogger()} method.
*/
default void initializeRoot(Logger aLogger) {
initializeRoot(aLogger, null, null);
}

/**
* Initializes a root UimaContext.
*
Expand All @@ -50,7 +60,10 @@ public interface UimaContextAdmin extends UimaContext {
* @param aConfigurationManager
* <b>Deprecated: this parameter is ignored!</b> The ConfigurationManager that will be
* used by this UimaContext to access its configuration parameter settings.
* @deprecated Use {@link #initializeRoot(Logger)} instead.
* @forRemoval 4.0.0
*/
@Deprecated(since = "3.6.0")
void initializeRoot(Logger aLogger, ResourceManager aResourceManager,
ConfigurationManager aConfigurationManager);

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.uima;

import org.apache.uima.resource.ConfigurationManager;
import org.apache.uima.resource.ResourceManager;
import org.apache.uima.util.Logger;

public class UimaContextAdminBuilder {
private Logger logger;
private ResourceManager resourceManager;
private ConfigurationManager configManager;

public UimaContextAdminBuilder withLogger(Logger aLogger) {
logger = aLogger;
return this;
}

public UimaContextAdminBuilder withResourceManager(ResourceManager aResourceManager) {
resourceManager = aResourceManager;
return this;
}

public UimaContextAdminBuilder withConfigurationManager(ConfigurationManager aConfigManager) {
configManager = aConfigManager;
return this;
}

public UimaContextAdmin build() {
var actualLogger = logger != null ? logger : UIMAFramework.getLogger();
var actualResMgr = resourceManager != null ? resourceManager
: UIMAFramework.newDefaultResourceManager();
var actualCfgMgr = configManager != null ? configManager
: UIMAFramework.newConfigurationManager();

return UIMAFramework.newUimaContext(actualLogger, actualResMgr, actualCfgMgr);
}
}

0 comments on commit caeb6b4

Please sign in to comment.