Interface EncodingAlgorithmAttributes
- All Superinterfaces:
Attributes
- All Known Implementing Classes:
AttributesHolder
,EncodingAlgorithmAttributesImpl
Implementations shall ensure that the Attributes.getValue(int)
method
correctly returns a String object even if the attribute is represented
as algorithm data.
If an attribute has algorithm data then the getAlgorithmData(int)
method
shall return a non null
value.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiongetAlgorithmData
(int index) Return the data of the encoding algorithm.int
getAlgorithmIndex
(int index) Return the index of the encoding algorithm.getAlgorithmURI
(int index) Return the URI of the encoding algorithm.getAlpababet
(int index) Return the alphabet associated with the attribute value.boolean
getToIndex
(int index) Return the whether the attribute value should be indexed or not.
-
Method Details
-
getAlgorithmURI
Return the URI of the encoding algorithm.If the algorithm data corresponds to a built-in encoding algorithm then the null is returned.
If the algorithm data corresponds to an application-defined encoding algorithm then the URI of the algorithm is returned.
If
getAlgorithmData(int)
returns null then the result of this method is undefined.- Parameters:
index
- The attribute index (zero-based).- Returns:
- The URI. If the index is out of range then null is returned.
-
getAlgorithmIndex
int getAlgorithmIndex(int index) Return the index of the encoding algorithm.If
getAlgorithmData(int)
returns null then the result of this method is undefined.- Parameters:
index
- The attribute index (zero-based).- Returns:
- The algorithm index. If index is out of range then -1 is returned.
- See Also:
-
getAlgorithmData
Return the data of the encoding algorithm.If the algorithm data corresponds to a built-in encoding algorithm then an Object corresponding to the Java primitive type is returned.
If the algorithm data corresponds to an application-defined encoding algorithm then an Object that is an instance of
byte[]
is returned if there is no EncodingAlgorithm registered for the application-defined encoding algorithm URI. Otherwise, an Object produced from the registeredEncodingAlgorithm is returned.If there no encoding algorithm data associated an attribute then
null
is returned.- Parameters:
index
- The attribute index (zero-based).- Returns:
- The data. If the index is out of range then null is returned.
-
getAlpababet
Return the alphabet associated with the attribute value.- Parameters:
index
- The attribute index (zero-based).- Returns:
- The alphabet. If the index is out of range then null is returned. If there is is no alphabet then null is returned.
-
getToIndex
boolean getToIndex(int index) Return the whether the attribute value should be indexed or not.- Parameters:
index
- The attribute index (zero-based).- Returns:
- True if attribute value should be indexed, otherwise false.
-