Package org.anchoranalysis.feature.input
Interface FeatureInputDictionary
- All Superinterfaces:
FeatureInput,FeatureInputWithResolution
- All Known Implementing Classes:
FeatureInputEnergy
public interface FeatureInputDictionary extends FeatureInputWithResolution
A
FeatureInputWithResolution that has an optional associated Dictionary.- Author:
- Owen Feehan
-
Method Summary
Modifier and Type Method Description Optional<Dictionary>getDictionaryOptional()The associated dictionary, if it exists.default DictionarygetDictionaryRequired()The associated dictionary, or an exception if it doesn't exist.Methods inherited from interface org.anchoranalysis.feature.input.FeatureInputWithResolution
getResolutionOptional, getResolutionRequired
-
Method Details
-
getDictionaryOptional
Optional<Dictionary> getDictionaryOptional()The associated dictionary, if it exists.- Returns:
- the dictionary, if it exists.
-
getDictionaryRequired
The associated dictionary, or an exception if it doesn't exist.- Returns:
- the dictionary.
- Throws:
FeatureCalculationException- if the dictionary doesn't exist.
-