Package org.apache.uima.cas_data.impl
Class FeatureStructureImpl
- java.lang.Object
-
- org.apache.uima.cas_data.impl.FeatureStructureImpl
-
- All Implemented Interfaces:
java.io.Serializable
,FeatureStructure
- Direct Known Subclasses:
PrimitiveArrayFSImpl
,ReferenceArrayFSImpl
public class FeatureStructureImpl extends java.lang.Object implements FeatureStructure
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Map<java.lang.String,FeatureValue>
mFeatureMap
private java.lang.String
mFSType
private java.lang.String
mId
private int[]
mIndexed
private static long
serialVersionUID
-
Constructor Summary
Constructors Constructor Description FeatureStructureImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.Object
get()
java.lang.String[]
getFeatureNames()
Gets the names of all features on this FeatureStructure.FeatureValue
getFeatureValue(java.lang.String aFeatureName)
Gets the value of a featurejava.lang.String
getId()
Gets the ID of this FeatureStructure.int[]
getIndexed()
Gets the index repositories that this FeatureStrucutre should be indexed in if the CasData is converted to a CAS Object.java.lang.String
getType()
Gets the type of this FeatureStructureboolean
isIndexed()
Deprecated.void
setFeatureValue(java.lang.String aFeatureType, FeatureValue aValue)
Sets the value of a featurevoid
setId(java.lang.String string)
Sets the ID of this FeatureStructure.void
setIndexed(boolean b)
Deprecated.void
setIndexed(int[] aIndexed)
Sets the index repositories that this FeatureStrucutre should be indexed in if the CasData is converted to a CAS Object.void
setType(java.lang.String aType)
Sets the type of this FeatureStructurejava.lang.String
toString()
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
mFeatureMap
private java.util.Map<java.lang.String,FeatureValue> mFeatureMap
-
mFSType
private java.lang.String mFSType
-
mId
private java.lang.String mId
-
mIndexed
private int[] mIndexed
-
-
Method Detail
-
getType
public java.lang.String getType()
Description copied from interface:FeatureStructure
Gets the type of this FeatureStructure- Specified by:
getType
in interfaceFeatureStructure
- Returns:
- this FeatureStructure's type, as a string
-
setType
public void setType(java.lang.String aType)
Description copied from interface:FeatureStructure
Sets the type of this FeatureStructure- Specified by:
setType
in interfaceFeatureStructure
- Parameters:
aType
- this FeatureStructure's type, as a string
-
getFeatureNames
public java.lang.String[] getFeatureNames()
Description copied from interface:FeatureStructure
Gets the names of all features on this FeatureStructure.- Specified by:
getFeatureNames
in interfaceFeatureStructure
- Returns:
- an array of feature names
-
getFeatureValue
public FeatureValue getFeatureValue(java.lang.String aFeatureName)
Description copied from interface:FeatureStructure
Gets the value of a feature- Specified by:
getFeatureValue
in interfaceFeatureStructure
- Parameters:
aFeatureName
- name of feature- Returns:
- value of feature named
aName
, or null if there is no such feature
-
setFeatureValue
public void setFeatureValue(java.lang.String aFeatureType, FeatureValue aValue)
Description copied from interface:FeatureStructure
Sets the value of a feature- Specified by:
setFeatureValue
in interfaceFeatureStructure
- Parameters:
aFeatureType
- name of feature to setaValue
- value of feature
-
get
public java.lang.Object get()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getId
public java.lang.String getId()
Description copied from interface:FeatureStructure
Gets the ID of this FeatureStructure. IDs are optional, so this may return null. A FeatureStructure must have an ID if it is to be the target of a reference.- Specified by:
getId
in interfaceFeatureStructure
- Returns:
- an ID string
-
isIndexed
@Deprecated public boolean isIndexed()
Deprecated.Description copied from interface:FeatureStructure
Gets whether this FeatureStructure should be indexed if the CasData is converted to a CAS Object. The CasData itself does not provide indexes.- Specified by:
isIndexed
in interfaceFeatureStructure
- Returns:
- true if it is indexed
-
setId
public void setId(java.lang.String string)
Description copied from interface:FeatureStructure
Sets the ID of this FeatureStructure. IDs are optional, so null may be passed to this method. A FeatureStructure must have an ID if it is to be the target of a reference.- Specified by:
setId
in interfaceFeatureStructure
- Parameters:
string
- -
-
setIndexed
@Deprecated public void setIndexed(boolean b)
Deprecated.Description copied from interface:FeatureStructure
Sets whether this FeatureStructure should be indexed if the CasData is converted to a CAS Object. The CasData itself does not provide indexes.- Specified by:
setIndexed
in interfaceFeatureStructure
- Parameters:
b
- true if this FS should be indexed, false if not
-
getIndexed
public int[] getIndexed()
Description copied from interface:FeatureStructure
Gets the index repositories that this FeatureStrucutre should be indexed in if the CasData is converted to a CAS Object. The CasData itself does not provide indexes.- Specified by:
getIndexed
in interfaceFeatureStructure
- Returns:
- an array containing the numbers of the index repsositories that should contain this FS. Returns an empty array if this FS is not indexed.
-
setIndexed
public void setIndexed(int[] aIndexed)
Description copied from interface:FeatureStructure
Sets the index repositories that this FeatureStrucutre should be indexed in if the CasData is converted to a CAS Object. The CasData itself does not provide indexes.- Specified by:
setIndexed
in interfaceFeatureStructure
- Parameters:
aIndexed
- an array containing the numbers of the index repsositories that should contain this FS. Passing null is equivalent to passing an empty array.
-
-