Index (lib 1.4 API)

A C D E F G H I K L M N P R S T U V W

A

add(UCDWord) - Method in class ari.ucidy.DeprecatedUCDWordList: Add the given deprecated UCD word.
add(UCDWord) - Method in class ari.ucidy.UCDWordList: Add the given UCD word.
addAll(Reader, boolean) - Method in class ari.ucidy.DeprecatedUCDWordList: Add all deprecated UCD words declared inside the specified reader.
addAll(Collection<UCDWord>) - Method in class ari.ucidy.UCDWordList: Add all the UCD words listed in the given collection.
addAll(UCDWord[]) - Method in class ari.ucidy.UCDWordList: Add all the UCD words listed in the given array.
addAll(File) - Method in class ari.ucidy.UCDWordList: Add all UCD words declared using the PSV (Pipe-Separated-Value) format inside the specified file.
addAll(File, boolean) - Method in class ari.ucidy.UCDWordList: Add all UCD words declared using the PSV (Pipe-Separated-Value) format inside the specified file.
addAll(InputStream, boolean) - Method in class ari.ucidy.UCDWordList: Add all UCD words declared using the PSV (Pipe-Separated-Value) format inside the specified input stream.
addAll(Reader, boolean) - Method in class ari.ucidy.UCDWordList: Add all UCD words declared using the PSV (Pipe-Separated-Value) format inside the specified reader.
advice - Variable in class ari.ucidy.UCD: List of advice concerning the construction of this UCD.
AdviceIterator() - Constructor for class ari.ucidy.UCD.AdviceIterator
allowedSyntaxCodes - Static variable in enum ari.ucidy.UCDSyntax: Human readable list of all possible syntaxes (in their character form) listed in this Enum class.
allRecognised - Variable in class ari.ucidy.UCD: Flag indicating that all words of this UCD are recognised.
allRecommended - Variable in class ari.ucidy.UCD: Flag indicating that all words of this UCD are recommended.
allValid - Variable in class ari.ucidy.UCD: Flag indicating that all words of this UCD are valid.
alreadyHasSuggestion - Variable in class ari.ucidy.UCD: Flag indicating that UCD.suggestion has been initialized when UCD.getSuggestion() is called.
append(StringBuffer, String) - Method in class ari.ucidy.UCD: Append the given UCD word at the end of the given StringBuffer.
ari.ucidy - package ari.ucidy

C

checkAllWords() - Method in class ari.ucidy.UCD: Check whether all words are valid, recognised and recommended.
checkFullValidity() - Method in class ari.ucidy.UCD: Check whether this UCD is fully valid.
clear() - Method in class ari.ucidy.UCDWordList: Remove ALL UCD words listed in this object.
closest - Variable in class ari.ucidy.UCDWord: This attribute is set by UCDParser.parse(String) when a UCD word can not be recognised.
compare(UCDWord, UCDWord) - Method in class ari.ucidy.UCDWordList.UCDWordComparator
concat(Collection<UCDWord>) - Method in class ari.ucidy.UCD: Concatenate each part of the given collection using UCD.append(StringBuffer, String).
contains(String) - Method in class ari.ucidy.UCDWordList: Tell whether the given UCD word is part of this list.
containsDeprecated() - Method in class ari.ucidy.UCD: Tell whether at least one word composing this UCD is UCDWord.isDeprecated() deprecated}.
countDeprecated() - Method in class ari.ucidy.UCD: Tell how many words composing this UCD are UCDWord.isDeprecated() deprecated}.
createSuggestion() - Method in class ari.ucidy.UCD: Try to create a fully valid UCD from this one if it is not already.

D

defaultParser - Static variable in class ari.ucidy.UCDParser: Default UCD parser which is initialized with a list of only the official IVOA UCD words and the deprecated ones (for better error messages and suggestions).
DeprecatedIterator() - Constructor for class ari.ucidy.UCD.DeprecatedIterator
DeprecatedUCDWordList - Class in ari.ucidy: Object listing and ordering alphabetically a set of deprecated UCD words.
DeprecatedUCDWordList(UCDWordList) - Constructor for class ari.ucidy.DeprecatedUCDWordList: Create a list of all deprecated list compared to the given list of "active" UCD words.
DeprecatedUCDWordList(UCDWordList, String) - Constructor for class ari.ucidy.DeprecatedUCDWordList: Create a list of all deprecated list compared to the given list of "active" UCD words.
deprecatedWords - Variable in class ari.ucidy.UCD: List of all UCDWord.isDeprecated() deprecated} words in this UCD.
deprecatedWords - Variable in class ari.ucidy.UCDParser: List of all deprecated words.
description - Variable in class ari.ucidy.UCDWord: Human description of this UCD word.

E

equals(Object) - Method in class ari.ucidy.UCD
equals(Object) - Method in class ari.ucidy.UCDWord
errors - Variable in class ari.ucidy.UCD: List of all errors preventing this UCD to be fully valid.
ErrorsIterator() - Constructor for class ari.ucidy.UCD.ErrorsIterator

F

FILE_UCD_DEPRECATED - Static variable in class ari.ucidy.UCDParser: Default path to the file listing all deprecated UCD words and their replacement.
FILE_UCD_WORDS - Static variable in class ari.ucidy.UCDParser: Default path to the PSV file listing all official IVOA UCDs.
fullyValid - Variable in class ari.ucidy.UCD: Flag indicating that the whole UCD is valid.

G

get(char) - Static method in enum ari.ucidy.UCDSyntax: Get the Enum item representing the given syntax code character.
get(String) - Method in class ari.ucidy.UCDWordList: Search for an exact match with the given UCD word but while ignoring their namespace.
get(String, boolean) - Method in class ari.ucidy.UCDWordList: Search for an exact match with the given supposed UCD word.
getAdvice() - Method in class ari.ucidy.UCD: Get advice about UCD words which is possible to add in order to be more precise.
getClosest(String) - Method in class ari.ucidy.UCDWordList: Search for a UCD word the closest as possible from the given one.
getDeprecated() - Method in class ari.ucidy.UCD: Get all UCD words composing this UCD that are considered as deprecated.
getErrors() - Method in class ari.ucidy.UCD: Get all detected errors preventing this UCD to be fully valid.
getFullVersion() - Method in class ari.ucidy.UCDParser: Get a paragraph giving the version of this parser and the version of all used lists.
getSuggestion() - Method in class ari.ucidy.UCD: Get a suggestion of a fully valid UCD created from this one if it is not already fully valid.
getVersion() - Static method in class ari.ucidy.UCDParser: Get the Ucidy/parser version.
getVersion() - Method in class ari.ucidy.UCDWordList: Get the version of this UCD words list.
getWord(int) - Method in class ari.ucidy.UCD: Get the specified UCD words of this UCD.

H

hashCode() - Method in class ari.ucidy.UCD
hashCode() - Method in class ari.ucidy.UCDWord
hasNext() - Method in class ari.ucidy.UCD.AdviceIterator
hasNext() - Method in class ari.ucidy.UCD.DeprecatedIterator
hasNext() - Method in class ari.ucidy.UCD.ErrorsIterator
hasNext() - Method in class ari.ucidy.UCD.WordsIterator

I

isAllRecognised() - Method in class ari.ucidy.UCD: Tell whether all words composing this UCD are recognised.
isAllRecommended() - Method in class ari.ucidy.UCD: Tell whether all words composing this UCD are recommended.
isAllValid() - Method in class ari.ucidy.UCD: Tell whether all words composing this UCD are valid.
isDeprecated() - Method in class ari.ucidy.UCDWord: Tell whether this UCD word is deprecated.
isForSameVersion() - Method in class ari.ucidy.DeprecatedUCDWordList: Tell whether this list is at a same version than its associated list of non-deprecated words.
isFullyValid() - Method in class ari.ucidy.UCD: Tell whether all words composing this UCD are recognised AND that their order inside the UCD is correct according to their syntax code.
iterator() - Method in class ari.ucidy.UCD: Let iterate over the list of all UCD words composing this UCD.
iterator() - Method in class ari.ucidy.UCDWordList: Let iterate (by alphabetic order) over the whole list of UCD words.
IVOA_NAMESPACE - Static variable in class ari.ucidy.UCDWord: Default namespace: ivoa.

K

knownWords - Variable in class ari.ucidy.UCDParser: List of all known words.

L

lev_min(int, int, int) - Static method in class ari.ucidy.UCDWordList: Compute the minimum value among the three given one.
levenshtein(String, String) - Static method in class ari.ucidy.UCDWordList: Compute the Levenshtein distance between the two given strings.
listAdvice() - Method in class ari.ucidy.UCD: Create a list of some advice.
listDeprecated() - Method in class ari.ucidy.UCD: Create a list of all deprecated words found inside this UCD.
listErrors() - Method in class ari.ucidy.UCD: Create a list of all errors.
LOGGER - Static variable in class ari.ucidy.UCDParser: Logger used to report errors during the initialization of the default UCDParser.
LOGGER - Static variable in class ari.ucidy.UCDWordList: Logger used to report errors during the initialization of the default UCDWordList.

M

main(String[]) - Static method in class ari.ucidy.UCDParser
main(String[]) - Static method in class ari.ucidy.UCDWordList
matches(int, String) - Method in class ari.ucidy.UCD: Tell whether the specified UCD word exists and matches the given regular expression.

N

namespace - Variable in class ari.ucidy.UCDWord: The namespace of this UCD, as extracted from UCDWord.rawWord.
NAMESPACE_SEP - Static variable in class ari.ucidy.UCDWord: Character used to separate the namespace prefix from a UCD word.
NB_MAX_ERRORS - Static variable in class ari.ucidy.UCDParser: Maximum number of consecutive errors while parsing a PSV file, before stopping the parsing.
next() - Method in class ari.ucidy.UCD.AdviceIterator
next() - Method in class ari.ucidy.UCD.DeprecatedIterator
next() - Method in class ari.ucidy.UCD.ErrorsIterator
next() - Method in class ari.ucidy.UCD.WordsIterator
nonDeprecatedWords - Variable in class ari.ucidy.DeprecatedUCDWordList: List of non deprecated words which complements this UCD words listed in this class.

P

parse(String) - Method in class ari.ucidy.UCDParser: Parse the given string representing a UCD into an object representation: UCD.
parseDeprecatedFileLine(String) - Static method in class ari.ucidy.UCDParser: Parse a line of a file listing the deprecated UCD words.
parseDeprecatedWordList(Reader, UCDWordList) - Static method in class ari.ucidy.UCDParser: Create a DeprecatedUCDWordList with all deprecated UCD words declared inside the specified input.
parseDeprecatedWordList(Reader, UCDWordList, DeprecatedUCDWordList) - Static method in class ari.ucidy.UCDParser: Add inside the given UCDWordList all deprecated UCD words declared inside the specified input.
parsePSVLine(String, boolean) - Static method in class ari.ucidy.UCDParser: Parse a line of a PSV (Pipe Separated Value) file as the definition of a UCD word.
parseUCD(String) - Static method in class ari.ucidy.UCDParser: Parse the given UCD and try to resolve each word as a known UCD word among the IVOA official list.
parseWordList(Reader, boolean) - Static method in class ari.ucidy.UCDParser: Create a UCDWordList with all UCD words declared using the PSV (Pipe-Separated-Value) format inside the specified input.
parseWordList(Reader, boolean, UCDWordList) - Static method in class ari.ucidy.UCDParser: Add inside the given UCDWordList all UCD words declared using the PSV (Pipe-Separated-Value) format inside the specified input.

R

rawWord - Variable in class ari.ucidy.UCDWord: The UCD word as provided (may have a namespace prefix).
recognised - Variable in class ari.ucidy.UCDWord: A UCD word is recognised if among a list of well-known UCD words (not necessarily the ones provided by the IVOA).
recommended - Variable in class ari.ucidy.UCDWord: A UCD word is recommended if allowed by the IVOA, according to IVOA Recommendation 2018-05-27 for the UCD1+ controlled vocabulary v1.3: http://www.ivoa.net/documents/UCD1+/20180527/index.html
REGEXP_AXIS_FRAME - Static variable in class ari.ucidy.UCD: Regular Expression for any UCD word describing an axis or a reference frame.
REGEXP_EM - Static variable in class ari.ucidy.UCD: Regular Expression for any UCD word describing a part of the electromagnetic spectrum.
REGEXP_UCD_ATOM - Static variable in class ari.ucidy.UCDWord: Regular Expression for a valid UCD's atom, according to the BNF provided in the IVOA Recommendation 2005-08-12 for UCD v1.1: http://www.ivoa.net/documents/REC/UCD/UCD-20050812.html
REGEXP_UCD_WORD - Static variable in class ari.ucidy.UCDWord: Regular Expression for a valid UCD, according to the BNF provided in the IVOA Recommendation 2005-08-12 for UCD v1.1: http://www.ivoa.net/documents/REC/UCD/UCD-20050812.html
remove() - Method in class ari.ucidy.UCD.AdviceIterator
remove() - Method in class ari.ucidy.UCD.DeprecatedIterator
remove() - Method in class ari.ucidy.UCD.ErrorsIterator
remove() - Method in class ari.ucidy.UCD.WordsIterator
remove(String) - Method in class ari.ucidy.UCDWordList: Remove the UCD word matching the given one.

S

search(String) - Method in class ari.ucidy.UCDWordList: Search for all UCD words whose the description matches the given keywords.
searchByPattern(String) - Method in class ari.ucidy.UCD: Search all UCD words composing this UCD which match the given regular expression.
size() - Method in class ari.ucidy.UCD: Get the total number of UCD words composing this UCD.
size() - Method in class ari.ucidy.UCDWordList: Total number of UCD words stored in this list.
startingWith(String) - Method in class ari.ucidy.UCDWordList: Search for all UCD words starting with the given string.
strRepresentation - Variable in class ari.ucidy.UCD: String serialization of this UCD.
suggestedReplacement - Variable in class ari.ucidy.UCDWord: If this UCD word is deprecated, this property will be not null.
suggestion - Variable in class ari.ucidy.UCD: Suggestion of a fully valid UCD.
syntaxCode - Variable in enum ari.ucidy.UCDSyntax: Character associated with this UCD syntax.
syntaxCode - Variable in class ari.ucidy.UCDWord: Rule about the syntax of the usage of this UCD word.

T

toString() - Method in class ari.ucidy.UCD
toString() - Method in class ari.ucidy.UCDWord

U

UCD - Class in ari.ucidy: Representation of a UCD.
UCD(Collection<UCDWord>) - Constructor for class ari.ucidy.UCD: Create a UCD with the given words.
UCD(UCDWord[]) - Constructor for class ari.ucidy.UCD: Create a UCD with the given words.
UCD.AdviceIterator - Class in ari.ucidy: Iterator over the list of advice.
UCD.DeprecatedIterator - Class in ari.ucidy: Iterator over the list of deprecated words.
UCD.ErrorsIterator - Class in ari.ucidy: Iterator over the list of all errors.
UCD.WordsIterator - Class in ari.ucidy: Iterator over the list of UCD words of this UCD.
UCDParser - Class in ari.ucidy: Object that lets parse a UCD (UCDParser.parseUCD(String)) or a list of UCD word (UCDParser.parseWordList(Reader, boolean)).
UCDParser() - Constructor for class ari.ucidy.UCDParser: Create a UCD parser with an empty list of known words.
UCDParser(String) - Constructor for class ari.ucidy.UCDParser: Create a UCD parser with an empty list of known words with a declared version.
UCDParser(UCDWordList) - Constructor for class ari.ucidy.UCDParser: Build a UCD parser with the given list of known words.
UCDParser(UCDWordList, DeprecatedUCDWordList) - Constructor for class ari.ucidy.UCDParser: Build a UCD parser with the given list of known words and a given list of deprecated UCD words.
UCDSyntax - Enum in ari.ucidy: All possible syntax rules as defined by the IVOA Recommendation 2018-05-27 for the UCD1+ controlled vocabulary v1.3: http://www.ivoa.net/documents/UCD1+/20180527/index.html
UCDWord - Class in ari.ucidy: Definition of a UCD word, according to the IVOA (v1.1 - 12 August 2005).
UCDWord(UCDSyntax, String, String, boolean) - Constructor for class ari.ucidy.UCDWord: Create a UCDWord.recognised (under conditions, see below) UCD word.
UCDWord(String) - Constructor for class ari.ucidy.UCDWord: Create a NON UCDWord.recommended and NON UCDWord.recognised UCD word.
UCDWord(String, UCDWord[]) - Constructor for class ari.ucidy.UCDWord: Create a NON UCDWord.recommended and NON UCDWord.recognised UCD word.
UCDWord(String, UCD, UCDSyntax, String) - Constructor for class ari.ucidy.UCDWord: Create a deprecated UCD word.
UCDWordComparator() - Constructor for class ari.ucidy.UCDWordList.UCDWordComparator
UCDWordList - Class in ari.ucidy: Object listing and ordering alphabetically a set of UCD words.
UCDWordList() - Constructor for class ari.ucidy.UCDWordList: Create an empty list of UCD words.
UCDWordList(String) - Constructor for class ari.ucidy.UCDWordList: Create an empty list of UCD words.
UCDWordList.UCDWordComparator - Class in ari.ucidy: Class used to sort the UCD words in this UCDWordList.
UCIDY_VERSION - Static variable in class ari.ucidy.UCDParser: Current version of this Ucidy instance.

V

valid - Variable in class ari.ucidy.UCDWord: A UCD is valid if its syntax is correct.
valueOf(String) - Static method in enum ari.ucidy.UCDSyntax: Returns the enum constant of this type with the specified name.
values() - Static method in enum ari.ucidy.UCDSyntax: Returns an array containing the constants of this enum type, in the order they are declared.
VERSION_UCD_WORDS - Static variable in class ari.ucidy.UCDParser: Version of the UCD words listed in UCDParser.FILE_UCD_WORDS and UCDParser.FILE_UCD_DEPRECATED.

W

word - Variable in class ari.ucidy.UCDWord: The UCD word (without namespace prefix), as extracted from UCDWord.rawWord.
words - Variable in class ari.ucidy.UCD: UCD words composing this UCD.
words - Variable in class ari.ucidy.UCDWordList: List of all known UCD words.
WordsIterator() - Constructor for class ari.ucidy.UCD.WordsIterator

A C D E F G H I K L M N P R S T U V W