Package org.apache.uima.cas.impl
Class TypeSystemUtils
java.lang.Object
org.apache.uima.cas.impl.TypeSystemUtils
Type Utilities - all static, so class is abstract to prevent creation Used by Feature Path
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
(package private) static class
(package private) static class
static enum
(package private) static class
(package private) static class
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic final int
classifyType
(Type type) Classify types into FS type, array type etc.static boolean
(package private) static boolean
isIdentifierChar
(char c) (package private) static boolean
isIdentifierStart
(char c) (package private) static boolean
private static final TypeSystemUtils.PathValid
isPathValid
(TypeImpl type, Deque<String> path, TypeSystemUtils.PathValid status) Recursively called on each successive path element.static final TypeSystemUtils.PathValid
isPathValid
(Type type, List<String> path) Given a starting Type and a list of features representing a feature path, checks if a feature path is valid for a given type.private static final TypeSystemUtils.PathValid
isPathValidInSubtypes
(TypeImpl type, String fName, Deque<String> nextPath) Called when the Feature Name is not a valid feature of the currenttype
.(package private) static boolean
isTypeName
(String name) Check ifname
is a possible type name.(package private) static boolean
isTypeNameSpaceName
(String name)
-
Field Details
-
NAMESPACE_SEPARATOR_AS_STRING
- See Also:
-
-
Constructor Details
-
TypeSystemUtils
public TypeSystemUtils()
-
-
Method Details
-
isIdentifier
-
isNonQualifiedName
-
isIdentifierStart
static boolean isIdentifierStart(char c) -
isIdentifierChar
static boolean isIdentifierChar(char c) -
isTypeName
Check ifname
is a possible type name. Does not check if this type actually exists!- Parameters:
name
- The name to check.- Returns:
true
iffname
is a possible type name.
-
isTypeNameSpaceName
-
isPathValid
Given a starting Type and a list of features representing a feature path, checks if a feature path is valid for a given type.
We distinguish three cases:
PathValid.NEVER
: there is no object oftype
on whichpath
can ever be defined.PathValid.ALWAYS
: if all intermediate objects are non-null, thispath
will always be defined on any object oftype
.PathValid.POSSIBLE
: some objects oftype
will havepath
defined, while others may not.
-
isPathValid
private static final TypeSystemUtils.PathValid isPathValid(TypeImpl type, Deque<String> path, TypeSystemUtils.PathValid status) Recursively called on each successive path element. Pops a feature name off the path, and checks if it exists for the type. -- if exists, gets its range type and iterates via recursion. Stops when the queue of feature names is empty.- Parameters:
type
-path
-status
- the returned value if the feature is found.- Returns:
-
isPathValidInSubtypes
private static final TypeSystemUtils.PathValid isPathValidInSubtypes(TypeImpl type, String fName, Deque<String> nextPath) Called when the Feature Name is not a valid feature of the currenttype
. It examines all the subtypes to see if it can find one for which the feature is valid. If the feature name is found in any subtype (recursively) of the type - given one subtype is found having the feature, continue the checking of subsequent features in the path - to see if there's some path where all the features are found. -- if so, return PathValid.POSSIBLE. -- if not, loop to try other subtypes. - if no subtypes have all the features, return PathValid.NEVER. The subtypes are descended when the feature name isn't a feature of a subtype, to see if a sub-sub-type might define the feature. The subtypes for one type are iterated while they have no match at any depth for the feature name- Parameters:
type
- the type whose subtypes should be checkedfName
-nextPath
-- Returns:
-
classifyType
Classify types into FS type, array type etc. For the full list of return types, see theLowLevelCAS.TYPE_CLASS*
constants, as well as the documentation forLowLevelCAS.ll_getTypeClass(int)
.- Parameters:
type
- The type to classify.- Returns:
- An integer encoding the the type class. See above.
-