Package org.apache.uima.cas.impl
Class FeaturePathImpl
java.lang.Object
org.apache.uima.cas.impl.FeaturePathImpl
- All Implemented Interfaces:
FeaturePath
Implementation of the feature path interface.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
private byte
private static final String
private Type
private int
private String
private static final byte
private static final byte
private static final String
private static final String
private static final String
private static final byte
private static final String
private static final byte
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addFeature
(Feature feat) Add a new feature at the end of the path.private static String
convertToString
(String[] array) Converts a string array to a comma separated string.private String
evaluateBuiltInFunction
(FeatureStructure returnFS) evaluate the built-in function for the returned FeatureStructureReturns the Boolean value of a boolean valued feature path.Returns the Byte value of a byte valued feature path.Returns the Double value of a double valued feature path.getFeature
(int i) Get feature at position.Returns the feature path as string.Returns the Float value of a float valued feature path.Returns the FeatureStructure of a FeatureStructure valued feature path.Returns the Integer value of an integer valued feature path.Returns the Long value of a long valued feature path.Returns the Short value of a short valued feature path.Returns the String value of a string valued feature path.Returns the type class of the feature path.Returns the type of the feature path.private FeaturePathValue
getValue
(int fsRef, LowLevelCAS llCas) evaluates the internal feature path for the given FeatureStructure data.Returns the feature path value as string for the given FeatureStructure.void
initialize
(String featurePath) Initialize the feature path object with the given feature path string.ll_getValueAsString
(int fsRef, LowLevelCAS llCas) Returns the feature path value as string for the given FeatureStructure.int
size()
Get length of path.private void
throwBuiltInFunctionException
(String typeName) Method that throws the CASRuntimeException for an unsupported built-in functionvoid
Check the feature path for the given type and initialize internal structures for faster access to the feature path value.
-
Field Details
-
MESSAGE_DIGEST
- See Also:
-
FEATURE_PATH_SEPARATOR
- See Also:
-
BUILT_IN_FUNCTION_SEPARATOR
- See Also:
-
NO_BUILT_IN_FUNCTION
private static final byte NO_BUILT_IN_FUNCTION- See Also:
-
FUNCTION_COVERED_TEXT
private static final byte FUNCTION_COVERED_TEXT- See Also:
-
FUNCTION_ID
private static final byte FUNCTION_ID- See Also:
-
FUNCTION_TYPE_NAME
private static final byte FUNCTION_TYPE_NAME- See Also:
-
FUNCTION_NAME_COVERED_TEXT
- See Also:
-
FUNCTION_NAME_ID
- See Also:
-
FUNCTION_NAME_TYPE_NAME
- See Also:
-
builtInFunction
private byte builtInFunction -
featurePathString
-
featurePathElementNames
-
featurePathElements
-
ll_featurePathElements
-
featurePathBaseType
-
featurePathBaseTypeCode
private int featurePathBaseTypeCode
-
-
Constructor Details
-
FeaturePathImpl
public FeaturePathImpl()Constructor to create a new featurePath object
-
-
Method Details
-
addFeature
Description copied from interface:FeaturePath
Add a new feature at the end of the path.- Specified by:
addFeature
in interfaceFeaturePath
- Parameters:
feat
- The feature to be added.
-
getFeature
Description copied from interface:FeaturePath
Get feature at position.- Specified by:
getFeature
in interfaceFeaturePath
- Parameters:
i
- The position in the path (starting at0
).- Returns:
- The feature, or
null
if there is no such feature.
-
size
public int size()Description copied from interface:FeaturePath
Get length of path.- Specified by:
size
in interfaceFeaturePath
- Returns:
- An integer
>= 0
.
-
initialize
Description copied from interface:FeaturePath
Initialize the feature path object with the given feature path string.- Specified by:
initialize
in interfaceFeaturePath
- Parameters:
featurePath
- The featurePath that is used for this feature path object.- Throws:
CASException
- Throws an exception if the feature path syntax is invalid.
-
typeInit
Description copied from interface:FeaturePath
Check the feature path for the given type and initialize internal structures for faster access to the feature path value.- Specified by:
typeInit
in interfaceFeaturePath
- Parameters:
featurePathType
- The type the feature path should be used on.- Throws:
CASException
- Throws an exception if the feature path is not valid for the given type
-
getFeaturePath
Description copied from interface:FeaturePath
Returns the feature path as string.- Specified by:
getFeaturePath
in interfaceFeaturePath
- Returns:
- Returns the feature path as string.
-
getBooleanValue
Description copied from interface:FeaturePath
Returns the Boolean value of a boolean valued feature path.- Specified by:
getBooleanValue
in interfaceFeaturePath
- Parameters:
fs
- FeatureStructure to evaluate the feature path value- Returns:
- Returns the Boolean value of a boolean valued feature path or null if the feature path was not set
-
getByteValue
Description copied from interface:FeaturePath
Returns the Byte value of a byte valued feature path.- Specified by:
getByteValue
in interfaceFeaturePath
- Parameters:
fs
- FeatureStructure to evaluate the feature path value- Returns:
- Returns the Byte value of a byte valued feature path or null if the feature path was not set
-
getDoubleValue
Description copied from interface:FeaturePath
Returns the Double value of a double valued feature path.- Specified by:
getDoubleValue
in interfaceFeaturePath
- Parameters:
fs
- FeatureStructure to evaluate the feature path value- Returns:
- Returns the Double value of a double valued feature path or null if the feature path was not set
-
getFloatValue
Description copied from interface:FeaturePath
Returns the Float value of a float valued feature path.- Specified by:
getFloatValue
in interfaceFeaturePath
- Parameters:
fs
- FeatureStructure to evaluate the feature path value- Returns:
- Returns the Float value of a float valued feature path or null if the feature path was not set
-
getFSValue
Description copied from interface:FeaturePath
Returns the FeatureStructure of a FeatureStructure valued feature path.- Specified by:
getFSValue
in interfaceFeaturePath
- Parameters:
fs
- FeatureStructure to evaluate the feature path value- Returns:
- Returns the FeatureStructure value of a FeatureStructure valued feature path or null if the feature path was not set
-
getIntValue
Description copied from interface:FeaturePath
Returns the Integer value of an integer valued feature path.- Specified by:
getIntValue
in interfaceFeaturePath
- Parameters:
fs
- FeatureStructure to evaluate the feature path value- Returns:
- Returns the Integer value of a integer valued feature path or null if the feature path was not set
-
getLongValue
Description copied from interface:FeaturePath
Returns the Long value of a long valued feature path.- Specified by:
getLongValue
in interfaceFeaturePath
- Parameters:
fs
- FeatureStructure to evaluate the feature path value- Returns:
- Returns the Long value of a long valued feature path or null if the feature path was not set
-
getShortValue
Description copied from interface:FeaturePath
Returns the Short value of a short valued feature path.- Specified by:
getShortValue
in interfaceFeaturePath
- Parameters:
fs
- FeatureStructure to evaluate the feature path value- Returns:
- Returns the Short value of a short valued feature path or null if the feature path was not set
-
getStringValue
Description copied from interface:FeaturePath
Returns the String value of a string valued feature path.- Specified by:
getStringValue
in interfaceFeaturePath
- Parameters:
fs
- FeatureStructure to evaluate the feature path value- Returns:
- Returns the String value of a string valued feature path or null if the feature path was not set
-
getType
Description copied from interface:FeaturePath
Returns the type of the feature path.- Specified by:
getType
in interfaceFeaturePath
- Parameters:
fs
- FeatureStructure to evaluate the feature path type- Returns:
- Returns the type of the feature path or null if the feature path is not set.
-
getTypClass
Description copied from interface:FeaturePath
Returns the type class of the feature path.- Specified by:
getTypClass
in interfaceFeaturePath
- Parameters:
fs
- FeatureStructure to evaluate the feature path type class- Returns:
- Returns the type class of the feature path or null if the feature path is not set
-
getValueAsString
Description copied from interface:FeaturePath
Returns the feature path value as string for the given FeatureStructure. If the feature path contains a built-in function it is evaluated and the built-in function value is returned. If the feature path ends with an array the array is converted to a comma separated string.- Specified by:
getValueAsString
in interfaceFeaturePath
- Parameters:
fs
- FeatureStructure to evaluate the feature path value- Returns:
- Returns the value of the feature path as String or null if the feature path was not set
-
ll_getValueAsString
Description copied from interface:FeaturePath
Returns the feature path value as string for the given FeatureStructure. If the feature path contains a built-in function it is evaluated and the built-in function value is returned. If the feature path ends with an array the array is converted to a comma separated string.- Specified by:
ll_getValueAsString
in interfaceFeaturePath
- Parameters:
fsRef
- FeatureStructure reference (LowLevel API) to evaluate the feature path valuellCas
- LowLevelCAS for the fsRef- Returns:
- Returns the value of the feature path as String
-
throwBuiltInFunctionException
Method that throws the CASRuntimeException for an unsupported built-in function- Parameters:
typeName
- type name that does not support the built-in function
-
evaluateBuiltInFunction
evaluate the built-in function for the returned FeatureStructure- Parameters:
returnFS
- FeatureStructure that is returned- Returns:
- Returns the built-in function value for the given FS.
-
convertToString
Converts a string array to a comma separated string.- Parameters:
array
- array to convert- Returns:
- returns comma separated string of the given string array
-
getValue
evaluates the internal feature path for the given FeatureStructure data. It returns the FeaturePathValue object that contains the value of the feature path with some meta data information.- Parameters:
fsRef
- FeatureStructure to evaluate the feature pathllCas
- LowLevelCAS for the fsRef- Returns:
- Returns a featurePathValue object or null if the feature path value was not set
-