Uses of Class
net.sf.okapi.common.LocaleId

Packages that use LocaleId

Package	Description
net.sf.okapi.common	Classes commonly used across the whole Okapi Framework.
net.sf.okapi.common.annotation	Classes to implement and manage annotations.
net.sf.okapi.common.filters	Interfaces and base classes to implement filters
net.sf.okapi.common.filterwriter	Interfaces and classes to allow the output of a document in its original format.
net.sf.okapi.common.pipeline	Interfaces and classes to implement and manage pipelines.
net.sf.okapi.common.pipelinebuilder
net.sf.okapi.common.pipelinedriver	Interfaces and classes to implement and pipeline drivers.
net.sf.okapi.common.query	Helper classes for the translation resources connectors.
net.sf.okapi.common.resource	Interfaces and classes that represent the parsed resources attached to the events sent by a filter.
net.sf.okapi.common.resource.simplifier
net.sf.okapi.common.skeleton	Interfaces and classes for the skeleton objects.

Uses of LocaleId in net.sf.okapi.common

Fields in net.sf.okapi.common declared as LocaleId

Modifier and Type	Field and Description
static LocaleId	IPredefinedLocales.Afrikaans
static LocaleId	IPredefinedLocales.Albanian
static LocaleId	LocaleId.ALL
static LocaleId	IPredefinedLocales.Amharic
static LocaleId	LocaleId.ARABIC LocaleId constant for "ar".
static LocaleId	IPredefinedLocales.Armenian
static LocaleId	LocaleId.AUTODETECT Same as EMPTY, but reminds the user that some components use EMPTY as a setting to enable locale auto detection.
static LocaleId	IPredefinedLocales.Aymara
static LocaleId	IPredefinedLocales.Basque
static LocaleId	IPredefinedLocales.Bikolano
static LocaleId	IPredefinedLocales.Bislama
static LocaleId	IPredefinedLocales.Bulgarian
static LocaleId	IPredefinedLocales.Burmese
static LocaleId	IPredefinedLocales.Cebuano
static LocaleId	LocaleId.CHINA_CHINESE LocaleId constant for "zh-cn".
static LocaleId	IPredefinedLocales.Chuukese
static LocaleId	IPredefinedLocales.Croatian
static LocaleId	IPredefinedLocales.Czech
static LocaleId	IPredefinedLocales.Danish
static LocaleId	IPredefinedLocales.Dutch
static LocaleId	IPredefinedLocales.Efik
static LocaleId	LocaleId.EMPTY An empty locale.
static LocaleId	LocaleId.ENGLISH LocaleId constant for "en".
static LocaleId	IPredefinedLocales.Estonian
static LocaleId	IPredefinedLocales.Fante
static LocaleId	IPredefinedLocales.Fijian
static LocaleId	IPredefinedLocales.Finnish
static LocaleId	LocaleId.FRENCH LocaleId constant for "fr".
static LocaleId	IPredefinedLocales.Georgian
static LocaleId	LocaleId.GERMAN LocaleId constant for "de".
static LocaleId	IPredefinedLocales.Greek
static LocaleId	IPredefinedLocales.Guarani
static LocaleId	IPredefinedLocales.Haitian
static LocaleId	LocaleId.HEBREW LocaleId constant for "he".
static LocaleId	IPredefinedLocales.Hiligaynon
static LocaleId	IPredefinedLocales.Hindi
static LocaleId	IPredefinedLocales.Hindi_Fiji
static LocaleId	IPredefinedLocales.Hmong
static LocaleId	IPredefinedLocales.Hungarian
static LocaleId	IPredefinedLocales.Iban
static LocaleId	IPredefinedLocales.Icelandic
static LocaleId	IPredefinedLocales.Igbo
static LocaleId	IPredefinedLocales.Ilocano
static LocaleId	IPredefinedLocales.Indonesian
static LocaleId	LocaleId.ITALIAN LocaleId constant for "it".
static LocaleId	LocaleId.JAPANESE LocaleId constant for "ja".
static LocaleId	IPredefinedLocales.Kannada
static LocaleId	IPredefinedLocales.Kazakh
static LocaleId	IPredefinedLocales.Kekchi
static LocaleId	IPredefinedLocales.Khmer
static LocaleId	IPredefinedLocales.Kirghiz
static LocaleId	IPredefinedLocales.Kiribati
static LocaleId	IPredefinedLocales.Korean
static LocaleId	LocaleId.KOREAN LocaleId constant for "ko".
static LocaleId	IPredefinedLocales.Kosraean
static LocaleId	IPredefinedLocales.Lao
static LocaleId	IPredefinedLocales.Latvian
static LocaleId	IPredefinedLocales.Lingala
static LocaleId	IPredefinedLocales.Lithuanian
static LocaleId	IPredefinedLocales.Macedonian
static LocaleId	IPredefinedLocales.Malagasy
static LocaleId	IPredefinedLocales.Malay_Malaysia
static LocaleId	IPredefinedLocales.Malayalam
static LocaleId	IPredefinedLocales.Maltese
static LocaleId	IPredefinedLocales.Mam
static LocaleId	IPredefinedLocales.Marshallese
static LocaleId	IPredefinedLocales.Mongolian
static LocaleId	IPredefinedLocales.Navajo
static LocaleId	IPredefinedLocales.Neomelanesian
static LocaleId	IPredefinedLocales.Norwegian
static LocaleId	IPredefinedLocales.Palauan
static LocaleId	IPredefinedLocales.Pohnpeian
static LocaleId	IPredefinedLocales.Polish
static LocaleId	LocaleId.PORTUGUESE LocaleId constant for "pt".
static LocaleId	IPredefinedLocales.Quechua
static LocaleId	IPredefinedLocales.Quichua
static LocaleId	IPredefinedLocales.Rarotongan
static LocaleId	IPredefinedLocales.Romanian
static LocaleId	LocaleId.RUSSIAN LocaleId constant for "ru".
static LocaleId	IPredefinedLocales.Rwanda
static LocaleId	IPredefinedLocales.Samoan
static LocaleId	IPredefinedLocales.Serbian
static LocaleId	IPredefinedLocales.Shona
static LocaleId	IPredefinedLocales.Slovak
static LocaleId	IPredefinedLocales.Slovenian
static LocaleId	IPredefinedLocales.South_Sotho
static LocaleId	LocaleId.SPANISH LocaleId constant for "es".
static LocaleId	IPredefinedLocales.Swahili
static LocaleId	IPredefinedLocales.Swedish
static LocaleId	IPredefinedLocales.Tagalog
static LocaleId	IPredefinedLocales.Tahitian
static LocaleId	LocaleId.TAIWAN_CHINESE LocaleId constant for "zh-tw".
static LocaleId	IPredefinedLocales.Thai
static LocaleId	IPredefinedLocales.Tongan
static LocaleId	IPredefinedLocales.Tswana
static LocaleId	IPredefinedLocales.Turkish
static LocaleId	IPredefinedLocales.Twi
static LocaleId	IPredefinedLocales.Ukrainian
static LocaleId	LocaleId.US_ENGLISH LocaleId constant for "en-US".
static LocaleId	IPredefinedLocales.Vietnamese
static LocaleId	IPredefinedLocales.Waray
static LocaleId	IPredefinedLocales.Xhosa
static LocaleId	IPredefinedLocales.Yapese
static LocaleId	IPredefinedLocales.Yoruba
static LocaleId	IPredefinedLocales.Yupik
static LocaleId	IPredefinedLocales.Zulu

Methods in net.sf.okapi.common that return LocaleId

Modifier and Type	Method and Description
LocaleId	LocaleId.clone() Returns a clone of this LocaleId.
static LocaleId	LocaleId.fromBCP47(String langtag) Creates a new LocaleId from a BCP-47 language tag.
static LocaleId	LocaleId.fromBCP47(String langtag, boolean strict) Creates a new LocaleId from a BCP-47 language tag.
static LocaleId	LocaleId.fromPOSIXLocale(String locId) Creates a new LocaleId from a POSIX locale identifier.
static LocaleId	LocaleId.fromString(String locId) Creates a new LocaleId from a locale identifier (and validate it).
static LocaleId[]	LocaleId.getAvailableLocales() Gets an array of the LocaleId objects for all the Java locales installed on the system.
LocaleId	ISegmenter.getLanguage() Gets the language used to apply the rules.
static LocaleId	LCIDUtil.getLocaleId(int lcid) Creates a locale id for a given LCID value.
static LocaleId	LCIDUtil.getLocaleId(String tag) Creates a locale id for a given language tag.
LocaleId	DefaultLocalePair.source()
LocaleId	LocalePair.source() Obtains the source locale.
LocaleId	DefaultLocalePair.target()
LocaleId	LocalePair.target() Obtains the target locale.

Methods in net.sf.okapi.common that return types with arguments of type LocaleId

Modifier and Type	Method and Description
static List<LocaleId>	LocaleId.convertToLocaleIds(List<String> languageCodes) Converts a list of language codes into LocaleIds
Set<LocaleId>	LocaleFilter.filter(LocaleId... localeIds) Creates a subset of the locales from a given array, which are allowed by this locale filter.
List<LocaleId>	LocaleFilter.getExcludes() Gets a list of disallowed locales.
List<LocaleId>	LocaleFilter.getIncludes() Gets a list of allowed locales.
static List<LocaleId>	ListUtil.stringAsLanguageList(String input) Splits up a string of comma-separated substrings representing locale codes into a string list of LocaleId objects.

Methods in net.sf.okapi.common with parameters of type LocaleId

Modifier and Type	Method and Description
static LocaleFilter	LocaleFilter.anyExcept(LocaleId... localeIds) Creates a filter filtering out the given locales.
static LocaleFilter	LocaleFilter.anyOf(LocaleId... localeIds) Creates a filter allowing only the given locales.
LocaleFilter	LocaleFilter.exclude(LocaleId... localeIds) Disallows the locales from a given array of locales.
LocaleFilter	LocaleFilter.exclude(LocaleId localeId) Disallows a given locale.
Set<LocaleId>	LocaleFilter.filter(LocaleId... localeIds) Creates a subset of the locales from a given array, which are allowed by this locale filter.
static String	LCIDUtil.getLCID_asString(LocaleId locId) Gets the LCID as a string, for a given locale id.
static int	LCIDUtil.getLCID(LocaleId locId) Gets the LCID for a given locale id.
static String	FileUtil.getLocaleBasedFile(String baseName, String extension, LocaleId locale) Return a path to a locale based resource using the standard java property resource resolution.
static String	LCIDUtil.getTag(LocaleId locId) Gets the language tag for a given locale id.
static boolean	LocaleId.hasCharactersAsNumeralSeparators(LocaleId localeId) Checks whether the specified locale has characters as numeral separators.
LocaleFilter	LocaleFilter.include(LocaleId... localeIds) Allows the locales from a given array of locales.
LocaleFilter	LocaleFilter.include(LocaleId localeId) Allows a given locale.
static boolean	LocaleId.isBidirectional(LocaleId locId) Indicates if a given locale usually uses a bi-directional script.
static boolean	Util.isNullOrEmpty(LocaleId locale) Indicates if a locale id is null or empty.
boolean	LocaleFilter.matches(LocaleId localeId) Returns true if a given locale is allowed by this locale filter.
static void	RenumberingUtil.renumberTextUnitCodes(ITextUnit tu, LocaleId trgLocale) Renumber the codes in the TextUnit's source container, then align with the codes in the target.
static String	LocaleId.replaceVariables(String input, LocaleId srcLoc, LocaleId trgLoc) Replaces the locale/language variables in a given input string by their runtime values.
boolean	LocaleId.sameLanguageAs(LocaleId other) Indicates if the language of a given LocaleId is the same as the one of this LocaleId.
boolean	LocaleId.sameRegionAs(LocaleId other) Indicates if the region of a given LocaleId is the same as the one of this LocaleId.
boolean	LocaleId.sameUserPartAs(LocaleId other) Indicates if the user part of a given LocaleId is the same as the one of this LocaleId.
void	ISegmenter.setLanguage(LocaleId locale) Sets the locale used to apply the rules.

Method parameters in net.sf.okapi.common with type arguments of type LocaleId

Modifier and Type	Method and Description
LocaleFilter	LocaleFilter.exclude(List<LocaleId> localeIds) Disallows the locales from a given list of locales.
LocaleFilter	LocaleFilter.exclude(Set<LocaleId> localeIds) Disallows the locales from a given set of locales.
LocaleFilter	LocaleFilter.include(List<LocaleId> localeIds) Allows the locales from a given list of locales.
LocaleFilter	LocaleFilter.include(Set<LocaleId> localeIds) Allows the locales from a given set of locales.

Constructors in net.sf.okapi.common with parameters of type LocaleId

Constructor and Description
DefaultLocalePair(LocaleId source, LocaleId target)

Uses of LocaleId in net.sf.okapi.common.annotation

Methods in net.sf.okapi.common.annotation that return LocaleId

Modifier and Type	Method and Description
LocaleId	AltTranslation.getSourceLocale() Gets the source locale for this entry.
LocaleId	AltTranslation.getTargetLocale() Gets the target locale for this entry.

Methods in net.sf.okapi.common.annotation with parameters of type LocaleId

Modifier and Type	Method and Description
AltTranslation	AltTranslationsAnnotation.add(LocaleId sourceLocId, LocaleId targetLocId, TextFragment originalSource, TextFragment alternateSource, TextFragment alternateTarget, MatchType type, int combinedScore, String origin) Adds a new entry to the list of alternate translations.
AltTranslation	AltTranslationsAnnotation.add(LocaleId sourceLocId, LocaleId targetLocId, TextFragment originalSource, TextFragment alternateSource, TextFragment alternateTarget, MatchType type, int combinedScore, String origin, int fuzzyScore, int qualityScore) Adds a new entry to the list of alternate translations.
void	AltTranslation.setTarget(LocaleId targetLocId, TextFragment alternateTarget) Sets the target parts of this alternate translation.

Constructors in net.sf.okapi.common.annotation with parameters of type LocaleId

Constructor and Description
AltTranslation(LocaleId sourceLocId, LocaleId targetLocId, TextFragment originalSource, TextFragment alternateSource, TextFragment alternateTarget, MatchType type, int combinedScore, String origin) Creates a new AltTranslation object.
AltTranslation(LocaleId sourceLocId, LocaleId targetLocId, TextFragment originalSource, TextFragment alternateSource, TextFragment alternateTarget, MatchType type, int combinedScore, String origin, int fuzzyScore, int qualityScore) Creates a new AltTranslation object.

Uses of LocaleId in net.sf.okapi.common.filters

Fields in net.sf.okapi.common.filters declared as LocaleId

Modifier and Type	Field and Description
protected LocaleId	AbstractLineFilter.srcLang
protected LocaleId	AbstractLineFilter.trgLang

Methods in net.sf.okapi.common.filters that return LocaleId

Modifier and Type	Method and Description
LocaleId	AbstractFilter.getSrcLoc() Gets the input document source locale.
LocaleId	EventBuilder.getTargetLocale() Get the current target locale.
protected LocaleId	AbstractLineFilter.getTargetLocale()
LocaleId	AbstractFilter.getTrgLoc()

Methods in net.sf.okapi.common.filters with parameters of type LocaleId

Modifier and Type	Method and Description
void	SubFilterSkeletonWriter.TargetOutputs.add(LocaleId localeId, StringBuilder stringBuilder)
void	SubFilterSkeletonWriter.TargetOutputs.Default.add(LocaleId localeId, StringBuilder stringBuilder)
void	EventBuilder.addToTextUnit(Code code, boolean endCodeNow, LocaleId locale, List<PropertyTextUnitPlaceholder> propertyTextUnitPlaceholders) Add a Code to the current TextUnit.
void	SubFilterSkeletonWriter.TargetOutputs.appendTo(LocaleId localeId, String text)
void	SubFilterSkeletonWriter.TargetOutputs.Default.appendTo(LocaleId localeId, String text)
Ending	EventBuilder.endGroup(GenericSkeleton endMarker, LocaleId locale, List<PropertyTextUnitPlaceholder> propertyTextUnitPlaceholders) Create a Ending Event of type END_GROUP and add it to the event queue.
ITextUnit	EventBuilder.endTextUnit(GenericSkeleton endMarker, LocaleId locale, List<PropertyTextUnitPlaceholder> propertyTextUnitPlaceholders) End the current TextUnit and place the Event on the event queue.
String	SubFilterSkeletonWriter.getEncodedOutput(LocaleId locToUse)
StringBuilder	SubFilterSkeletonWriter.TargetOutputs.outputFor(LocaleId localeId)
StringBuilder	SubFilterSkeletonWriter.TargetOutputs.Default.outputFor(LocaleId localeId)
String	SubFilterSkeletonWriter.processStartDocument(LocaleId outputLocale, String outputEncoding, ILayerProvider layer, EncoderManager encoderManager, StartDocument resource)
void	AbstractFilter.setOptions(LocaleId sourceLocale, LocaleId targetLocale, String defaultEncoding, boolean generateSkeleton) Each IFilter has a small set of options beyond normal configuration that gives the IFilter the needed information to properly parse the content.
SubFilterSkeletonWriter	SubFilterSkeletonWriter.setOptions(LocaleId outputLocale, String outputEncoding, StartSubfilter startSubfilter, ILayerProvider layer)
void	AbstractFilter.setSrcLoc(LocaleId srcLoc) Sets the input document source locale.
void	EventBuilder.setTargetLocale(LocaleId targetLocale) Set the target locale.
void	AbstractFilter.setTrgLoc(LocaleId trgLoc)
void	EventBuilder.startDocumentPart(String part, String name, LocaleId locale, List<PropertyTextUnitPlaceholder> propertyTextUnitPlaceholders) Create a DocumentPart that references actionable (i.e., translatable, localizable) properties and store it for later processing.
StartGroup	EventBuilder.startGroup(GenericSkeleton startMarker, String commonTagType, LocaleId locale, List<PropertyTextUnitPlaceholder> propertyTextUnitPlaceholders) Create a StartGroup Event and add it to the event queue.
void	EventBuilder.startTextUnit(String text, GenericSkeleton startMarker, LocaleId locale, List<PropertyTextUnitPlaceholder> propertyTextUnitPlaceholders) Start a complex TextUnit with actionable (translatable, writable or read-only) attributes.

Constructor parameters in net.sf.okapi.common.filters with type arguments of type LocaleId

Constructor and Description
Default(Map<LocaleId,StringBuilder> outputs)

Uses of LocaleId in net.sf.okapi.common.filterwriter

Methods in net.sf.okapi.common.filterwriter that return LocaleId

Modifier and Type	Method and Description
LocaleId	GenericFilterWriter.getLocale()
LocaleId	ZipFilterWriter.getLocale()
LocaleId	TMXWriter.getSrcLoc()
LocaleId	TMXWriter.getTrgLoc()

Methods in net.sf.okapi.common.filterwriter with parameters of type LocaleId

Modifier and Type	Method and Description
void	XLIFFWriter.create(String xliffPath, String skeletonPath, LocaleId srcLoc, LocaleId trgLoc, String dataType, String original, String message) Creates a new XLIFF document.
void	ITSContent.outputAnnotations(GenericAnnotations anns, StringBuilder output, boolean inline, boolean mrk, boolean mtypeNeeded, LocaleId trgLocId) Generates the markup for the ITS attributes for a given annotation set.
protected void	GenericFilterWriter.processStartDocument(LocaleId outputLocale, String outputEncoding, StartDocument resource)
protected void	GenericFilterWriter.setLocale(LocaleId locale)
void	XLIFFWriter.setOptions(LocaleId locale, String defaultEncoding)
void	IFilterWriter.setOptions(LocaleId locale, String defaultEncoding) Sets the options for this writer.
void	TMXFilterWriter.setOptions(LocaleId locale, String defaultEncoding) Sets the options for this writer.
void	GenericFilterWriter.setOptions(LocaleId locale, String defaultEncoding)
void	ZipFilterWriter.setOptions(LocaleId locale, String defaultEncoding)
void	TMXWriter.setSrcLoc(LocaleId srcLoc)
void	TMXWriter.setTrgLoc(LocaleId trgLoc)
String	XLIFFContent.toSegmentedString(TextContainer container, int quoteMode, boolean escapeGT, boolean withMarkers, boolean gMode, boolean codeAttrs, boolean includeIts, LocaleId trgLocId) Generates an XLIFF string from a given text container.
String	XLIFFContent.toString(int quoteMode, boolean escapeGT, boolean codeOnlyMode, boolean gMode, boolean codeAttrs, boolean includeIts, LocaleId trgLocId) Generates an XLIFF string from the content.
void	TMXWriter.writeAlternates(ITextUnit tu, LocaleId trgLoc) Writes the entries of an AltTranslationsAnnotation annotation(s) of a given text unit to the TMX document.
void	TMXWriter.writeStartDocument(LocaleId sourceLocale, LocaleId targetLocale, String creationTool, String creationToolVersion, String segType, String originalTMFormat, String dataType) Writes the start of the TMC document.
void	TMXWriter.writeStartDocument(StartDocument startDocument, LocaleId sourceLocale, LocaleId targetLocale, String creationTool, String creationToolVersion, String segType, String originalTMFormat, String dataType) Writes the start of the TMC document.
void	TMXWriter.writeTU(TextFragment source, TextFragment target, String tuid, Map<String,String> attributes, LocaleId altTrgLoc) Writes a TMX TU element.
void	TMXWriter.writeTUFull(ITextUnit item, LocaleId sourceLocId) Writes a TextUnit (all targets) with all the properties associated to it.
protected void	TMXWriter.writeTUV(TextFragment frag, LocaleId locale, TextContainer contForProp) Writes a TUV element.

Uses of LocaleId in net.sf.okapi.common.pipeline

Methods in net.sf.okapi.common.pipeline that return LocaleId

Modifier and Type	Method and Description
default LocaleId	IPipelineStep.getSourceLocale() Delegate to concrete class
LocaleId	BasePipelineStep.getSourceLocale()
default LocaleId	IPipelineStep.getTargetLocale() Delegate to concrete class
LocaleId	BasePipelineStep.getTargetLocale()

Methods in net.sf.okapi.common.pipeline with parameters of type LocaleId

Modifier and Type	Method and Description
default void	IPipelineStep.setSourceLocale(LocaleId sourceLocale) Delegate to concrete class
void	BasePipelineStep.setSourceLocale(LocaleId sourceLocale)
default void	IPipelineStep.setTargetLocale(LocaleId targetLocale)
void	BasePipelineStep.setTargetLocale(LocaleId targetLocale)

Uses of LocaleId in net.sf.okapi.common.pipelinebuilder

Methods in net.sf.okapi.common.pipelinebuilder with parameters of type LocaleId

Modifier and Type	Method and Description
XBatch	XBatch.addItem(String dir, String file, String defaultEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XBatch	XBatch.addItem(String dir, String file, String defaultEncoding, URI outputURI, String outputEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XBatch	XBatch.addItems(String dir, String[] fileList, String defaultEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XBatch	XBatch.addItems(String dir, String[] fileList, String defaultEncoding, URI outputURI, String outputEncoding, LocaleId sourceLocale, LocaleId targetLocale)

Constructors in net.sf.okapi.common.pipelinebuilder with parameters of type LocaleId

Constructor and Description
XBatchItem(CharSequence inputCharSequence, LocaleId sourceLocale)
XBatchItem(InputStream inputStream, String defaultEncoding, LocaleId sourceLocale)
XBatchItem(InputStream inputStream, String defaultEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XBatchItem(InputStream inputStream, String defaultEncoding, String outputPath, String outputEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XBatchItem(URI inputURI, String defaultEncoding, LocaleId sourceLocale)
XBatchItem(URI inputURI, String defaultEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XBatchItem(URI inputURI, String defaultEncoding, String filterConfigId, URI outputURI, String outputEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XBatchItem(URI inputURI, String defaultEncoding, URI outputURI, String outputEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XBatchItem(URL inputURL, String defaultEncoding, LocaleId sourceLocale)
XBatchItem(URL inputURL, String defaultEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XBatchItem(URL inputURL, String defaultEncoding, String outputPath, String outputEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XBatchItem(URL inputURL, String defaultEncoding, URL outputURL, String outputEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XDocument(CharSequence inputCharSequence, LocaleId sourceLocale)
XDocument(InputStream inputStream, String defaultEncoding, LocaleId sourceLocale)
XDocument(InputStream inputStream, String defaultEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XDocument(InputStream inputStream, String defaultEncoding, String outputPath, String outputEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XDocument(URI inputURI, String defaultEncoding, LocaleId sourceLocale)
XDocument(URI inputURI, String defaultEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XDocument(URI inputURI, String defaultEncoding, LocaleId sourceLocale, LocaleId targetLocale, String filterConfigId)
XDocument(URI inputURI, String defaultEncoding, String filterConfigId, URI outputURI, String outputEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XDocument(URI inputURI, String defaultEncoding, URI outputURI, String outputEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XDocument(URL inputURL, String defaultEncoding, LocaleId sourceLocale)
XDocument(URL inputURL, String defaultEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XDocument(URL inputURL, String defaultEncoding, String outputPath, String outputEncoding, LocaleId sourceLocale, LocaleId targetLocale)
XDocument(URL inputURL, String defaultEncoding, URL outputURL, String outputEncoding, LocaleId sourceLocale, LocaleId targetLocale)

Uses of LocaleId in net.sf.okapi.common.pipelinedriver

Methods in net.sf.okapi.common.pipelinedriver that return LocaleId

Modifier and Type	Method and Description
LocaleId	BatchItemContext.getSourceLocale(int index)
LocaleId	IBatchItemContext.getSourceLocale(int index) Gets the source locale for a given input document of this batch item.
LocaleId	BatchItemContext.getTargetLocale(int index)
LocaleId	IBatchItemContext.getTargetLocale(int index) Gets the target locale for a given input document of this batch item.

Methods in net.sf.okapi.common.pipelinedriver with parameters of type LocaleId

Modifier and Type	Method and Description
void	PipelineDriver.addBatchItem(URI inputURI, String defaultEncoding, String filterConfigId, LocaleId srcLoc, LocaleId trgLoc)
void	IPipelineDriver.addBatchItem(URI inputURI, String defaultEncoding, String filterConfigId, LocaleId srcLoc, LocaleId trgLoc) Adds an item to this batch, using direct parameters.

Constructors in net.sf.okapi.common.pipelinedriver with parameters of type LocaleId

Constructor and Description
BatchItemContext(URI inputURI, String defaultEncoding, String filterConfigId, URI outputURI, String outputEncoding, LocaleId sourceLocale, LocaleId targetLocale) Creates a new BatchItemContext object and initializes it based on a given input URI and additional arguments.

Uses of LocaleId in net.sf.okapi.common.query

Methods in net.sf.okapi.common.query that return LocaleId

Modifier and Type	Method and Description
LocaleId	IQuery.getSourceLanguage() Gets the current source language for this query engine.
LocaleId	IQuery.getTargetLanguage() Gets the current target language for this query engine.

Methods in net.sf.okapi.common.query with parameters of type LocaleId

Modifier and Type	Method and Description
void	IQuery.setLanguages(LocaleId sourceLocale, LocaleId targetLocale) Sets the source and target languages for this query engine.
AltTranslation	QueryResult.toAltTranslation(TextFragment originalSource, LocaleId sourceLocId, LocaleId targetLocId) Convert a QueryResult to an AltTranslation

Uses of LocaleId in net.sf.okapi.common.resource

Fields in net.sf.okapi.common.resource declared as LocaleId

Modifier and Type	Field and Description
protected LocaleId	StartDocument.locale

Methods in net.sf.okapi.common.resource that return LocaleId

Modifier and Type	Method and Description
LocaleId	StartSubfilter.getLocale()
LocaleId	StartDocument.getLocale() Gets the locale of this document.
LocaleId	AlignedPair.getLocaleId() Gets the LocaleId of the target parts
LocaleId	PipelineParameters.getSourceLocale()
LocaleId	RawDocument.getSourceLocale() Gets the source locale associated to this resource.
LocaleId	PipelineParameters.getTargetLocale()
LocaleId	RawDocument.getTargetLocale() Gets the target locale associated to this resource.

Methods in net.sf.okapi.common.resource that return types with arguments of type LocaleId

Modifier and Type	Method and Description
Set<LocaleId>	TargetPropertiesAnnotation.getLocales() Gets a set of the target locales available in this annotation.
List<LocaleId>	PipelineParameters.getTargetLocales()
default Set<LocaleId>	IWithTargetProperties.getTargetLocales() Gets all the target locales for this resource.
List<LocaleId>	RawDocument.getTargetLocales() Gets the list of target locales associated to this resource.
Set<LocaleId>	TextUnit.getTargetLocales()
Iterator<LocaleId>	TargetPropertiesAnnotation.iterator() Gets a new iterator for this annotation.

Methods in net.sf.okapi.common.resource with parameters of type LocaleId

Modifier and Type	Method and Description
void	AlignedSegments.align(List<AlignedPair> alignedSegmentPairs, LocaleId trgLoc)
void	IAlignedSegments.align(List<AlignedPair> alignedSegmentPairs, LocaleId trgLoc) Aligns all the segments listed in the aligned pairs for given locale.
void	AlignedSegments.align(LocaleId trgLoc) Force one to one alignment.
void	IAlignedSegments.align(LocaleId trgLoc) Aligns all the target segments with the source segments for the given locale.
void	AlignedSegments.alignCollapseAll(LocaleId trgLoc)
void	IAlignedSegments.alignCollapseAll(LocaleId trgLoc) Aligns all the segments for the specified sources and targets by collapsing all segments into one.
void	AlignedSegments.append(Segment srcSeg, Segment trgSeg, LocaleId trgLoc)
void	IAlignedSegments.append(Segment srcSeg, Segment trgSeg, LocaleId trgLoc) Adds given source and target segments to the end of the content.
static ITextUnit	TextUnitUtil.buildGenericTU(ITextUnit textUnit, String name, TextContainer source, TextContainer target, LocaleId locId, String comment) Creates a new generic text unit resource or updates the one passed as the parameter.
SubFilterSkeletonWriter	StartSubfilter.createSkeletonWriter(StartSubfilter resource, LocaleId outputLocale, String outputEncoding, ILayerProvider layer)
TextContainer	TextUnit.createTarget(LocaleId targetLocale, boolean overwriteExisting, int creationOptions)
TextContainer	ITextUnit.createTarget(LocaleId locId, boolean overwriteExisting, int creationOptions) Creates or get the target for this TextUnit.
default Property	IWithTargetProperties.createTargetProperty(LocaleId locId, String name, boolean overwriteExisting, int creationOptions) Create target Property without access to the source property
Property	TextUnit.createTargetProperty(LocaleId locId, String name, boolean overwriteExisting, int creationOptions)
default Property	IWithTargetProperties.createTargetProperty(LocaleId locId, String name, Property sourceProperty, boolean overwriteExisting, int creationOptions) Creates or get a target property based on the corresponding source.
void	TextUnit.createTargetSegmentation(ISegmenter segmenter, LocaleId targetLocale)
void	ITextUnit.createTargetSegmentation(ISegmenter segmenter, LocaleId targetLocale) Segments the specified target content based on the rules provided by a given ISegmenter.
Map<String,Property>	TargetPropertiesAnnotation.get(LocaleId locId) Gets the properties for a given target locale.
AlignmentStatus	AlignedSegments.getAlignmentStatus(LocaleId trgLoc)
AlignmentStatus	IAlignedSegments.getAlignmentStatus(LocaleId trgLoc) Gets the status of the alignment the given target locale in this text unit.
Segment	AlignedSegments.getCorrespondingSource(Segment trgSeg, LocaleId trgLoc)
Segment	IAlignedSegments.getCorrespondingSource(Segment trgSeg, LocaleId trgLoc) Gets the source segment corresponding to a given target segment
Segment	AlignedSegments.getCorrespondingTarget(Segment srcSeg, LocaleId trgLoc)
Segment	IAlignedSegments.getCorrespondingTarget(Segment seg, LocaleId trgLoc) Gets the target segment corresponding to a given source segment
Segment	AlignedSegments.getSource(int index, LocaleId trgLoc)
Segment	IAlignedSegments.getSource(int index, LocaleId trgLoc) Gets the source segment for the given target locale at a given position.
TextContainer	TextUnit.getTarget(LocaleId locId)
TextContainer	ITextUnit.getTarget(LocaleId locId) Gets the target object for this text unit for a given locale.
static <A extends IAnnotation> A	TextUnitUtil.getTargetAnnotation(ITextUnit textUnit, LocaleId locId, Class<A> type) Gets an annotation attached to the target part of a given text unit resource in a given locale.
default Map<String,Property>	IWithTargetProperties.getTargetProperties(LocaleId locale)
default Property	IWithTargetProperties.getTargetProperty(LocaleId locId, String name) Gets the target property for a given name and target locale.
Property	TextUnit.getTargetProperty(LocaleId locId, String name)
default Set<String>	IWithTargetProperties.getTargetPropertyNames(LocaleId locId) Gets the names of all the properties for a given target locale in this resource.
Set<String>	TextUnit.getTargetPropertyNames(LocaleId locId)
Segment	TextUnit.getTargetSegment(LocaleId trgLoc, String segId, boolean createIfNeeded)
Segment	ITextUnit.getTargetSegment(LocaleId trgLoc, String segId, boolean createIfNeeded) Gets the segment for a given segment id in a given target.
ISegments	TextUnit.getTargetSegments(LocaleId trgLoc)
ISegments	ITextUnit.getTargetSegments(LocaleId trgLoc) Get the segments for a given target.
static String	TextUnitUtil.getTargetText(ITextUnit textUnit, LocaleId locId) Gets text of the first part of the target of a given text unit resource in the given locale.
boolean	TextUnit.hasTarget(LocaleId locId)
boolean	ITextUnit.hasTarget(LocaleId locId) Indicates if there is a target object for a given locale for this text unit.
default boolean	IWithTargetProperties.hasTargetProperty(LocaleId locId, String name) Indicates if a property exists for a given name and target locale.
boolean	TextUnit.hasTargetProperty(LocaleId locId, String name)
void	AlignedSegments.insert(int index, Segment srcSeg, Segment trgSeg, LocaleId trgLoc)
void	IAlignedSegments.insert(int index, Segment srcSeg, Segment trgSeg, LocaleId trgLoc) Inserts given source and target segments at the specified position in the list of segments.
static boolean	TextUnitUtil.isApproved(ITextUnit tu, LocaleId targetLocale)
Iterator<Segment>	AlignedSegments.iterator(LocaleId trgLoc)
Iterator<Segment>	IAlignedSegments.iterator(LocaleId trgLoc) Gets an iterator for the source of the specified target locale.
void	AlignedSegments.joinAll(LocaleId trgLoc)
void	IAlignedSegments.joinAll(LocaleId trgLoc) Joins all segments for the specified sources and targets.
void	AlignedSegments.joinWithNext(Segment seg, LocaleId trgLoc)
void	IAlignedSegments.joinWithNext(Segment seg, LocaleId trgLoc) Joins the segment for a given segment's id to the next segment, including all the parts between the two segments.
boolean	AlignedSegments.remove(Segment seg, LocaleId trgLoc)
boolean	IAlignedSegments.remove(Segment seg, LocaleId trgLoc) Removes the given segment and any segments with the same id from the specified sources and targets.
void	TextUnit.removeTarget(LocaleId locId)
void	ITextUnit.removeTarget(LocaleId locId) Removes a given target object from this text unit.
default void	IWithTargetProperties.removeTargetProperty(LocaleId locId, String name) Removes a target property of a given name.
void	TextUnit.removeTargetProperty(LocaleId locId, String name)
void	AlignedSegments.segmentSource(ISegmenter segmenter, LocaleId targetLocale)
void	IAlignedSegments.segmentSource(ISegmenter segmenter, LocaleId targetLocale) Segments the source content used for the given target locale based on the rules provided by a given ISegmenter.
void	AlignedSegments.segmentTarget(ISegmenter segmenter, LocaleId targetLocale)
void	IAlignedSegments.segmentTarget(ISegmenter segmenter, LocaleId targetLocale) Segments the specified target content based on the rules provided by a given ISegmenter.
void	TargetPropertiesAnnotation.set(LocaleId locId, Map<String,Property> properties) Sets properties for a given target locale.
void	StartDocument.setLocale(LocaleId locale) Sets the locale of the document.
void	AlignedSegments.setSegment(int index, Segment seg, LocaleId trgLoc)
void	IAlignedSegments.setSegment(int index, Segment seg, LocaleId trgLoc) Replaces a segment at a given position with a clone of the given segment.
void	PipelineParameters.setSourceLocale(LocaleId sourceLocale)
void	RawDocument.setSourceLocale(LocaleId locId) Sets the source locale associated to this document.
TextContainer	TextUnit.setTarget(LocaleId locId, TextContainer text)
TextContainer	ITextUnit.setTarget(LocaleId locId, TextContainer text) Sets the target object for this text unit for a given locale.
static void	TextUnitUtil.setTargetAnnotation(ITextUnit textUnit, LocaleId locId, IAnnotation annotation) Attaches an annotation to the target part of a given text unit resource in a given language.
TextFragment	TextUnit.setTargetContent(LocaleId locId, TextFragment content)
TextFragment	ITextUnit.setTargetContent(LocaleId locId, TextFragment content) Sets the content of the target for a given locale for this TextUnit.
void	PipelineParameters.setTargetLocale(LocaleId targetLocale)
void	RawDocument.setTargetLocale(LocaleId locId) Sets the target locale associated to this document.
default Property	IWithTargetProperties.setTargetProperty(LocaleId locId, Property property) Sets a target property.
Property	TextUnit.setTargetProperty(LocaleId locId, Property property)
static void	TextUnitUtil.setTargetText(ITextUnit textUnit, LocaleId locId, String text) Sets the coded text of the the target part of a given text unit resource in a given language.
Segment	AlignedSegments.splitSource(LocaleId trgLoc, Segment srcSeg, int splitPos)
Segment	IAlignedSegments.splitSource(LocaleId trgLoc, Segment srcSeg, int splitPos) Splits a given source segment into two.
Segment	AlignedSegments.splitTarget(LocaleId trgLoc, Segment trgSeg, int splitPos)
Segment	IAlignedSegments.splitTarget(LocaleId trgLoc, Segment trgSeg, int splitPos) Splits a given target segment into two.

Method parameters in net.sf.okapi.common.resource with type arguments of type LocaleId

Modifier and Type	Method and Description
void	PipelineParameters.setTargetLocales(List<LocaleId> trgLocs)
void	RawDocument.setTargetLocales(List<LocaleId> locIds) Sets the list of target locales associated to this document.

Constructors in net.sf.okapi.common.resource with parameters of type LocaleId

Constructor and Description
AlignedPair(List<TextPart> sourceParts, List<TextPart> targetParts, LocaleId localeId) Creates an AlignedPair from source and target TextParts
AlignedPair(Segment sourceSegment, Segment targetSegment, LocaleId localeId) Creates an AlignedPair from source and target Segments
RawDocument(CharSequence inputCharSequence, LocaleId sourceLocale) Creates a new RawDocument object with a given CharSequence and a source locale.
RawDocument(CharSequence inputCharSequence, LocaleId sourceLocale, LocaleId targetLocale) Creates a new RawDocument object with a given CharSequence, a source locale and a target locale.
RawDocument(InputStream inputStream, String defaultEncoding, LocaleId sourceLocale) Creates a new RawDocument object with a given InputStream, a default encoding and a source locale.
RawDocument(InputStream inputStream, String defaultEncoding, LocaleId sourceLocale, LocaleId targetLocale) Creates a new RawDocument object with a given InputStream, a default encoding and a source locale.
RawDocument(URI inputURI, String defaultEncoding, LocaleId sourceLocale) Creates a new RawDocument object with a given URI, a default encoding and a source locale.
RawDocument(URI inputURI, String defaultEncoding, LocaleId sourceLocale, LocaleId targetLocale) Creates a new RawDocument object with a given URI, a default encoding, a source locale and a target locale.
RawDocument(URI inputURI, String defaultEncoding, LocaleId sourceLocale, LocaleId targetLocale, String filterConfigId) Creates a new RawDocument object with a given URI, a default encoding, a source locale and a target locale, and the filter configuration id.

Uses of LocaleId in net.sf.okapi.common.resource.simplifier

Methods in net.sf.okapi.common.resource.simplifier that return LocaleId

Modifier and Type	Method and Description
LocaleId	AbstractResourceSimplifier.getTargetLocale()

Methods in net.sf.okapi.common.resource.simplifier with parameters of type LocaleId

Modifier and Type	Method and Description
void	AbstractResourceSimplifier.setTargetLocale(LocaleId targetLocale)
void	IResourceSimplifier.setTargetLocale(LocaleId targetLocale)

Constructors in net.sf.okapi.common.resource.simplifier with parameters of type LocaleId

Constructor and Description
ResourceSimplifier(LocaleId trgLoc)

Uses of LocaleId in net.sf.okapi.common.skeleton

Fields in net.sf.okapi.common.skeleton declared as LocaleId

Modifier and Type	Field and Description
protected LocaleId	GenericSkeletonWriter.inputLoc
protected LocaleId	GenericSkeletonWriter.outputLoc

Methods in net.sf.okapi.common.skeleton that return LocaleId

Modifier and Type	Method and Description
LocaleId	GenericSkeletonWriter.getInputLoc()
LocaleId	GenericSkeletonPart.getLocale()
LocaleId	GenericSkeletonWriter.getOutputLoc()

Methods in net.sf.okapi.common.skeleton that return types with arguments of type LocaleId

Modifier and Type	Method and Description
Set<LocaleId>	StorageList.getTargetLocales()

Methods in net.sf.okapi.common.skeleton with parameters of type LocaleId

Modifier and Type	Method and Description
void	GenericSkeleton.addContentPlaceholder(ITextUnit textUnit, LocaleId locId) Adds to this skeleton a placeholder for the content (in a given locale) of the resource to which this skeleton is attached.
GenericSkeletonPart	GenericSkeleton.addValuePlaceholder(INameable referent, String propName, LocaleId locId) Adds to this skeleton a place-holder for the value of a property (in a given locale) of the resource to which this skeleton is attached.
Property	StorageList.createTargetProperty(LocaleId locId, String name, boolean overwrite, int creationOptions)
protected String	GenericSkeletonWriter.expandCodeContent(Code code, LocaleId locToUse, EncoderContext context)
static int	SkeletonUtil.findTuRefInSkeleton(GenericSkeleton skel, LocaleId locId) Finds either source or target reference in the skeleton.
protected String	GenericSkeletonWriter.getContent(ITextUnit tu, LocaleId locToUse, EncoderContext context) Gets the original content of a given text unit.
String	GenericSkeletonWriter.getContent(TextFragment tf, LocaleId locToUse, EncoderContext context) Gets the original content of a TextFragment.
protected String	GenericSkeletonWriter.getPropertyValue(INameable resource, String name, LocaleId locToUse, EncoderContext context)
protected String	GenericSkeletonWriter.getString(INameable ref, String propName, LocaleId locToUse, EncoderContext context)
protected String	GenericSkeletonWriter.getString(ITextUnit tu, LocaleId locToUse, EncoderContext context) Gets the skeleton and the original content of a given text unit.
protected String	GenericSkeletonWriter.getString(StorageList list, LocaleId locToUse, EncoderContext context)
Property	StorageList.getTargetProperty(LocaleId language, String name)
Set<String>	StorageList.getTargetPropertyNames(LocaleId language)
boolean	StorageList.hasTargetProperty(LocaleId language, String name)
static boolean	SkeletonUtil.hasTuRef(GenericSkeleton skel, LocaleId locId) Determines if a given skeleton contains a target reference in a given locale.
String	GenericSkeletonWriter.processStartDocument(LocaleId outputLocale, String outputEncoding, ILayerProvider layer, EncoderManager encoderManager, StartDocument resource)
String	ISkeletonWriter.processStartDocument(LocaleId outputLocale, String outputEncoding, ILayerProvider layer, EncoderManager encoderManager, StartDocument resource) Processes the START_DOCUMENT event.
void	StorageList.removeTargetProperty(LocaleId language, String name)
void	GenericSkeletonPart.setLocale(LocaleId locId)
void	GenericSkeletonWriter.setOutputLoc(LocaleId outputLoc)
Property	StorageList.setTargetProperty(LocaleId language, Property property)

Constructors in net.sf.okapi.common.skeleton with parameters of type LocaleId

Constructor and Description
GenericSkeletonPart(char data, IResource parent, LocaleId locId)
GenericSkeletonPart(String data, IResource parent, LocaleId locId)
GenericSkeletonSimplifier(boolean isMultilingual, GenericSkeletonWriter skelWriter, LocaleId trgLoc)
GenericSkeletonSimplifier(boolean isMultilingual, GenericSkeletonWriter skelWriter, String outEncoding, LocaleId trgLoc)
GenericSkeletonSimplifier(LocaleId trgLoc)
GenericSkeletonSimplifier(String outEncoding, LocaleId trgLoc)
GenericSkeletonWriter(LocaleId inputLoc, LocaleId outputLoc, ILayerProvider layer, EncoderManager encoderManager, boolean isMultilingual, boolean allowEmptyOutputTarget, Map<String,Referent> referents, Stack<StorageList> storageStack, String outputEncoding, int referentCopies, SubFilterSkeletonWriter sfWriter)