Package com.e1c.langtool.collector

Class CollectingParameters

java.lang.Object

com.e1c.langtool.collector.CollectingParameters

All Implemented Interfaces:

ICollectingParameters

public class CollectingParameters
extends Object
implements ICollectingParameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CollectingParameters.Builder

Nested classes/interfaces inherited from interface com.e1c.langtool.collector.ICollectingParameters

ICollectingParameters.CollectModelType

Field Summary

Fields inherited from interface com.e1c.langtool.collector.ICollectingParameters

DEFAULT

Constructor Summary

Constructors

Constructor	Description
CollectingParameters(boolean collectChildObjects, boolean collectModel, boolean collectInterface, boolean collectSubResources, ICollectingParameters.CollectModelType collectModelType, boolean collectEmptyValue, Set<TranslateLanguage> languages, boolean continueAfterFirstError, boolean useCache, boolean keepLanguagesMode)	Instantiates a new collecting parameters.

Method Summary

Modifier and Type	Method	Description
static CollectingParameters.Builder	builder()
ICollectingParameters.CollectModelType	getCollectModelType()	Gets the collect model type: any (include computed) strings, model strings that are non computed or model strings that are computed strings.
Collection<Exception>	getErrors()	Gets the errors which collected if ICollectingParameters.isContinueAfterFirstError() set to true.
Map<String,Object>	getFilterParameters()	Gets the filter parameters.
Set<TranslateLanguage>	getLanguages()	Gets the languages which collecting from source object.
boolean	isCollectChildObjects()	Checks if it is collecting child objects.
boolean	isCollectEmptyValue()	Checks if it is collecting FeatureValue with empty values.
boolean	isCollectInterfaceStrings()	Checks if it is collecting interface strings.
boolean	isCollectModelStrings()	Checks if it is collecting model strings.
boolean	isCollectSubResources()	Checks if it is collecting in sub resources.
boolean	isContinueAfterFirstError()	Checks if collecting should continue after first error.
boolean	isKeepLanguagesMode()	Checks if is keep languages mode.
boolean	useCache()	Use cached FeatureValue for the resource and for all it's child objects.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CollectingParameters

public CollectingParameters(boolean collectChildObjects,
 boolean collectModel,
 boolean collectInterface,
 boolean collectSubResources,
 ICollectingParameters.CollectModelType collectModelType,
 boolean collectEmptyValue,
 Set<TranslateLanguage> languages,
 boolean continueAfterFirstError,
 boolean useCache,
 boolean keepLanguagesMode)

Instantiates a new collecting parameters.

Parameters:

collectChildObjects - the collect child objects

collectModel - the collect model

collectInterface - the collect interface

collectSubResources - the collect sub resources

collectModelType - the collect model type

collectEmptyValue - the collect empty value

languages - collect source source strings for languages, if null or empty doesn't collect.

continueAfterFirstError - the continue after first error

useCache - the use cache

keepLanguagesMode - the is keep languages mode

Method Details

builder

public static CollectingParameters.Builder builder()

isCollectChildObjects

public boolean isCollectChildObjects()

Description copied from interface: ICollectingParameters

Checks if it is collecting child objects.

Specified by:

isCollectChildObjects in interface ICollectingParameters

Returns:

true to collect FeatureValue from child objects

isCollectModelStrings

public boolean isCollectModelStrings()

Description copied from interface: ICollectingParameters

Checks if it is collecting model strings.

Specified by:

isCollectModelStrings in interface ICollectingParameters

Returns:

true to collect model (none localizable) EFeatureSettings strings

isCollectInterfaceStrings

public boolean isCollectInterfaceStrings()

Description copied from interface: ICollectingParameters

Checks if it is collecting interface strings.

Specified by:

isCollectInterfaceStrings in interface ICollectingParameters

Returns:

true to collect interface or localizable EFeatureSettings strings

getCollectModelType

public ICollectingParameters.CollectModelType getCollectModelType()

Description copied from interface: ICollectingParameters

Gets the collect model type: any (include computed) strings, model strings that are non computed or model strings that are computed strings.

Specified by:

getCollectModelType in interface ICollectingParameters

Returns:

the collect model type

isCollectSubResources

public boolean isCollectSubResources()

Description copied from interface: ICollectingParameters

Checks if it is collecting in sub resources.

Specified by:

isCollectSubResources in interface ICollectingParameters

Returns:

true to collect in sub resources. It depends on concrete project implementation, some child objects could be store in different resources.

getLanguages

public Set<TranslateLanguage> getLanguages()

Description copied from interface: ICollectingParameters

Gets the languages which collecting from source object.

Specified by:

getLanguages in interface ICollectingParameters

Returns:

the set of TranslateLanguage to collect from source and add to FeatureValue.getLocalStrings() with language code, cannot be null.

isCollectEmptyValue

public boolean isCollectEmptyValue()

Description copied from interface: ICollectingParameters

Checks if it is collecting FeatureValue with empty values.

Specified by:

isCollectEmptyValue in interface ICollectingParameters

Returns:

true, if it is collecting empty value

isContinueAfterFirstError

public boolean isContinueAfterFirstError()

Description copied from interface: ICollectingParameters

Checks if collecting should continue after first error.

Specified by:

isContinueAfterFirstError in interface ICollectingParameters

Returns:

true, if it should continue after first error

getErrors

public Collection<Exception> getErrors()

Description copied from interface: ICollectingParameters

Gets the errors which collected if ICollectingParameters.isContinueAfterFirstError() set to true.

Specified by:

getErrors in interface ICollectingParameters

Returns:

the errors

getFilterParameters

public Map<String,Object> getFilterParameters()

Description copied from interface: ICollectingParameters

Gets the filter parameters.

Specified by:

getFilterParameters in interface ICollectingParameters

Returns:

the filter parameters

isKeepLanguagesMode

public boolean isKeepLanguagesMode()

Description copied from interface: ICollectingParameters

Checks if is keep languages mode.

Specified by:

isKeepLanguagesMode in interface ICollectingParameters

Returns:

true, if is keep languages mode

useCache

public boolean useCache()

Description copied from interface: ICollectingParameters

Use cached FeatureValue for the resource and for all it's child objects.

Specified by:

useCache in interface ICollectingParameters

Returns:

true, if need to use cache if available for the resource