Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow multiple output files of same type #35

Merged
merged 2 commits into from
Feb 14, 2024
Merged

Allow multiple output files of same type #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0c6762
add feature to allow key based outputfile paths
bischoffz Feb 14, 2024
8bc8153
version bump
bischoffz Feb 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions core/src/main/java/gov/hhs/aspr/ms/taskit/core/CoreTranslationError.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ public enum CoreTranslationError implements ContractError {

CIRCULAR_TRANSLATOR_DEPENDENCIES("Circular translator dependencies: "),
DUPLICATE_CLASSREF("Duplicate ClassRef"),
DUPLICATE_CLASSREF_SCENARIO_PAIR("Duplicate ClassRef and Scenario Pair"),
DUPLICATE_OUTPUT_PATH_KEY("Duplicate ClassRef and Scenario Pair"),
DUPLICATE_DEPENDENCY("Duplicate Dependency"),
DUPLICATE_INPUT_PATH("Duplicate Input Path"),
DUPLICATE_OUTPUT_PATH("Duplicate Output Path"),
Expand Down Expand Up @@ -40,7 +40,9 @@ public enum CoreTranslationError implements ContractError {
"Translators were added to the builder but were not initialized. Make sure to call super.initTranslators() during your custom engine build method"),
UNKNOWN_OBJECT("Object is not Translatable by this TranslationSpec"),
UNKNWON_TRANSLATION_ENGINE_TYPE("Translation Engine Type was not set"),
UNKNOWN_CLASSREF("No object has been read in with the specified classRef");
UNKNOWN_CLASSREF("No object has been read in with the specified classRef"),
UNKNOWN_OUTPUT_PATH_KEY("The provided key does not exist"),
MISSING_OUTPUT_PATH_KEYS("The number of keys provided does not match the number of objects to be written");

private final String description;

Expand Down
156 changes: 126 additions & 30 deletions core/src/main/java/gov/hhs/aspr/ms/taskit/core/TranslationController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
Expand All @@ -31,11 +32,11 @@ public final class TranslationController {
}

final static class Data {
protected Map<Class<? extends TranslationEngine>, TranslationEngine> translationEngines = new LinkedHashMap<>();
protected Set<TranslationEngine> translationEngines = new LinkedHashSet<>();
protected final List<Translator> translators = new ArrayList<>();
protected final Map<Path, Class<?>> inputFilePathMap = new LinkedHashMap<>();
protected final Map<Path, TranslationEngineType> inputFilePathEngine = new LinkedHashMap<>();
protected final Map<Pair<Class<?>, Integer>, Path> outputFilePathMap = new LinkedHashMap<>();
protected final Map<String, Path> outputFilePathMap = new LinkedHashMap<>();
protected final Map<Path, TranslationEngineType> outputFilePathEngine = new LinkedHashMap<>();
protected final Map<Class<?>, Class<?>> parentChildClassRelationshipMap = new LinkedHashMap<>();

Expand Down Expand Up @@ -83,7 +84,7 @@ private void validateTranslationEnginesNotNull() {
throw new ContractException(CoreTranslationError.NULL_TRANSLATION_ENGINE,
"No TranslationEngine Builders were added");
}
for (TranslationEngine engine : this.data.translationEngines.values()) {
for (TranslationEngine engine : this.data.translationEngines) {
validateTranslationEngineNotNull(engine);
}
}
Expand Down Expand Up @@ -145,7 +146,8 @@ public Builder addInputFilePath(Path filePath, Class<?> classRef, TranslationEng

/**
* Adds the path and class ref to be written to after building via
* {@link TranslationController#writeOutput} with a scenario id of 0
* {@link TranslationController#writeOutput} with the given classRef and
* scenario id of 0 as the key
*
* @throws ContractException
* <ul>
Expand All @@ -155,11 +157,13 @@ public Builder addInputFilePath(Path filePath, Class<?> classRef, TranslationEng
* if classRef is null</li>
* <li>{@linkplain CoreTranslationError#DUPLICATE_OUTPUT_PATH}
* if filePath has already been added</li>
* <li>{@linkplain CoreTranslationError#DUPLICATE_CLASSREF_SCENARIO_PAIR}
* <li>{@linkplain CoreTranslationError#DUPLICATE_OUTPUT_PATH_KEY}
* if the classRef and scenarioId pair has already
* been added</li>
* <li>{@linkplain CoreTranslationError#INVALID_OUTPUT_PATH}
* if filePath does not exist on the system</li>
* if filePath does not exist on the system. Note this
* check is for the folder, not the file. The file
* will be created if necessary by the writer</li>
* </ul>
*/
public Builder addOutputFilePath(Path filePath, Class<?> classRef,
Expand All @@ -169,7 +173,8 @@ public Builder addOutputFilePath(Path filePath, Class<?> classRef,

/**
* Adds the path and class ref to be written to after building via
* {@link TranslationController#writeOutput} with the given scenarioId
* {@link TranslationController#writeOutput} with the given classRef and
* scenarioId as the key
*
* @throws ContractException
* <ul>
Expand All @@ -179,23 +184,47 @@ public Builder addOutputFilePath(Path filePath, Class<?> classRef,
* if classRef is null</li>
* <li>{@linkplain CoreTranslationError#DUPLICATE_OUTPUT_PATH}
* if filePath has already been added</li>
* <li>{@linkplain CoreTranslationError#DUPLICATE_CLASSREF_SCENARIO_PAIR}
* <li>{@linkplain CoreTranslationError#DUPLICATE_OUTPUT_PATH_KEY}
* if the classRef and scenarioId pair has already
* been added</li>
* <li>{@linkplain CoreTranslationError#INVALID_OUTPUT_PATH}
* if filePath does not exist on the system</li>
* if filePath does not exist on the system. Note this
* check is for the folder, not the file. The file
* will be created if necessary by the writer</li>
* </ul>
*/
public Builder addOutputFilePath(Path filePath, Class<?> classRef, Integer scenarioId,
TranslationEngineType translationEngineType) {
validateFilePathNotNull(filePath);
validateClassRefNotNull(classRef);
validatePathNotDuplicate(filePath, false, true);

Pair<Class<?>, Integer> key = new Pair<>(classRef, scenarioId);
return this.addOutputFilePath(filePath, classRef.getName() + ":" + scenarioId, translationEngineType);
}

/**
* Adds the path and class ref to be written to after building via
* {@link TranslationController#writeOutput} with the given key
*
* @throws ContractException
* <ul>
* <li>{@linkplain CoreTranslationError#NULL_PATH} if
* filePath is null</li>
* <li>{@linkplain CoreTranslationError#DUPLICATE_OUTPUT_PATH}
* if filePath has already been added</li>
* <li>{@linkplain CoreTranslationError#DUPLICATE_OUTPUT_PATH_KEY}
* if the classRef and scenarioId pair has already
* been added</li>
* <li>{@linkplain CoreTranslationError#INVALID_OUTPUT_PATH}
* if filePath does not exist on the system. Note this
* check is for the folder, not the file. The file
* will be created if necessary by the writer</li>
* </ul>
*/
public Builder addOutputFilePath(Path filePath, String key, TranslationEngineType translationEngineType) {
validateFilePathNotNull(filePath);
validatePathNotDuplicate(filePath, false, true);

if (this.data.outputFilePathMap.containsKey(key)) {
throw new ContractException(CoreTranslationError.DUPLICATE_CLASSREF_SCENARIO_PAIR);
throw new ContractException(CoreTranslationError.DUPLICATE_OUTPUT_PATH_KEY);
}

if (!filePath.getParent().toFile().exists()) {
Expand Down Expand Up @@ -226,15 +255,15 @@ public Builder addOutputFilePath(Path filePath, Class<?> classRef, Integer scena
* added</li>
* </ul>
*/
public <M extends U, U> Builder addParentChildClassRelationship(Class<M> classRef, Class<U> markerInterface) {
public <M extends U, U> Builder addParentChildClassRelationship(Class<M> classRef, Class<U> parentClassRef) {
validateClassRefNotNull(classRef);
validateClassRefNotNull(markerInterface);
validateClassRefNotNull(parentClassRef);

if (this.data.parentChildClassRelationshipMap.containsKey(classRef)) {
throw new ContractException(CoreTranslationError.DUPLICATE_CLASSREF);
}

this.data.parentChildClassRelationshipMap.put(classRef, markerInterface);
this.data.parentChildClassRelationshipMap.put(classRef, parentClassRef);
return this;
}

Expand All @@ -250,7 +279,7 @@ public <M extends U, U> Builder addParentChildClassRelationship(Class<M> classRe
public Builder addTranslationEngine(TranslationEngine translationEngine) {
validateTranslationEngineNotNull(translationEngine);

this.data.translationEngines.put(translationEngine.getClass(), translationEngine);
this.data.translationEngines.add(translationEngine);

Map<Class<?>, Class<?>> childToParentClassMap = translationEngine.getChildParentClassMap();

Expand Down Expand Up @@ -313,13 +342,16 @@ <M extends U, U> void writeOutput(Path path, M object, Optional<Class<U>> superC
}

void initTranslationEngines() {
for (TranslationEngine translationEngine : this.data.translationEngines.values()) {
for (TranslationEngine translationEngine : this.data.translationEngines) {
translationEngine.translationSpecsAreInitialized();

this.translationEngines.put(translationEngine.getTranslationEngineType(), translationEngine);
this.translationEngineClassToTypeMap.put(translationEngine.getClass(),
translationEngine.getTranslationEngineType());
}

// since we are making a new mapping, clear the original set in the data
this.data.translationEngines.clear();
}

void validateTranslationEngine(TranslationEngine translationEngine) {
Expand Down Expand Up @@ -362,7 +394,6 @@ void validateTranslationEngines() {
}
}


/**
* passes every input path and classRef to
* the TranslationEngine via
Expand All @@ -383,36 +414,56 @@ public TranslationController readInput() {
/**
* Given the classRef and scenarioId, find the given outputFilePath. If the
* classRef Scenario pair has been added, that is returned. Otherwise, checks to
* see if the classRef exists in the markerInterfaceClassMap and if so, returns
* see if the classRef exists in the parentChildClassRelationshipMap and if so,
* returns
* the resulting classRef scenarioId pair
*
* @param <M> the childClass
* @param <U> the optional parentClass/MarkerInterfaceClass
*/
<M extends U, U> Pair<Path, Optional<Class<U>>> getOutputPath(Class<M> classRef, Integer scenarioId) {
Pair<Class<?>, Integer> key = new Pair<>(classRef, scenarioId);
<M extends U, U> Pair<String, Optional<Class<U>>> getOutputPathKey(Class<M> classRef, Integer scenarioId) {
String key = classRef.getName() + ":" + scenarioId;

if (this.data.outputFilePathMap.containsKey(key)) {
return new Pair<>(this.data.outputFilePathMap.get(key), Optional.empty());
return new Pair<>(key, Optional.empty());
}

if (this.data.parentChildClassRelationshipMap.containsKey(classRef)) {
// can safely cast because of type checking when adding to the
// markerInterfaceClassMap
// parentChildClassRelationshipMap
@SuppressWarnings("unchecked")
Class<U> parentClass = (Class<U>) this.data.parentChildClassRelationshipMap.get(classRef);

key = new Pair<>(parentClass, scenarioId);
key = parentClass.getName() + ":" + scenarioId;

if (this.data.outputFilePathMap.containsKey(key)) {
return new Pair<>(this.data.outputFilePathMap.get(key), Optional.of(parentClass));
return new Pair<>(key, Optional.of(parentClass));
}
}

throw new ContractException(CoreTranslationError.INVALID_OUTPUT_CLASSREF,
"No path was provided for " + classRef.getName());
}

/**
* Given the classRef and scenarioId, find the given outputFilePath. If the
* classRef Scenario pair has been added, that is returned. Otherwise, checks to
* see if the classRef exists in the parentChildClassRelationshipMap and if so,
* returns
* the resulting classRef scenarioId pair
*
* @param <M> the childClass
* @param <U> the optional parentClass/MarkerInterfaceClass
*/
<M extends U, U> Path getOutputPath(String key) {
if (this.data.outputFilePathMap.containsKey(key)) {
return this.data.outputFilePathMap.get(key);
}

throw new ContractException(CoreTranslationError.INVALID_OUTPUT_CLASSREF,
"No path was provided for " + key);
}

/**
* takes the list of objects and writes each object out to it's corresponding
* outputFilePath, if it exists
Expand All @@ -436,6 +487,28 @@ public <T> void writeOutput(List<T> objects) {
}
}

/**
* takes the list of objects and writes each object out to it's corresponding
* outputFilePath using the supplied key, if it exists
* <p>
* internally calls {@link TranslationController#writeOutput(Object)}
*
* @param <T> the type of the list of obects to write to output
* @throws ContractException
* <ul>
* <li>{@linkplain CoreTranslationError#INVALID_OUTPUT_CLASSREF}
* if the supplied key has no valid outputFilePath
* mapping</li>
* <li>{@linkplain CoreTranslationError#NULL_TRANSLATION_ENGINE}
* if translationEngine is null</li>
* </ul>
*/
public <T> void writeOutput(Map<String, T> objects) {
for (String key : objects.keySet()) {
this.writeOutput(objects.get(key), key);
}
}

/**
* takes the list of objects with the specified scenarioId and writes each
* object out to it's corresponding outputFilePath, if it exists
Expand Down Expand Up @@ -502,14 +575,37 @@ public <M extends U, U> void writeOutput(M object, Integer scenarioId) {
// this gives an unchecked warning, surprisingly
Class<M> classRef = (Class<M>) object.getClass();

Pair<Path, Optional<Class<U>>> pathPair = getOutputPath(classRef, scenarioId);
Path path = pathPair.getFirst();
Pair<String, Optional<Class<U>>> keyPair = getOutputPathKey(classRef, scenarioId);

this.writeOutput(object, keyPair.getFirst(), keyPair.getSecond());
}

/**
* takes the given object and scenarioId pair and writes it out to it's
* corresponding outputFilePath, if it exists
*
* @param <M> the classType of the object
* @throws ContractException
* <ul>
* <li>{@linkplain CoreTranslationError#INVALID_OUTPUT_CLASSREF}
* if the supplied key has no valid outputFilePath
* mapping</li>
* <li>{@linkplain CoreTranslationError#NULL_TRANSLATION_ENGINE}
* if translationEngine is null</li>
* </ul>
*/
public <M> void writeOutput(M object, String key) {
this.writeOutput(object, key, Optional.empty());
}

<M extends U, U> void writeOutput(M object, String key, Optional<Class<U>> parentClassRef) {
Path path = getOutputPath(key);

TranslationEngineType type = this.data.outputFilePathEngine.get(path);
TranslationEngine translationEngine = this.translationEngines.get(type);

this.writeOutput(path, object, pathPair.getSecond(), translationEngine);
this.writeOutput(path, object, parentClassRef, translationEngine);
}

/**
* Searches the list of read in objects and returns the first Object found of
* the given classRef
Expand Down
Loading