Package org.nuiton.eugene

Class EugeneCoreTagValues

java.lang.Object

org.nuiton.eugene.models.extension.tagvalue.provider.DefaultTagValueMetadatasProvider

org.nuiton.eugene.EugeneCoreTagValues

All Implemented Interfaces:

TagValueMetadatasProvider

@Component(role=TagValueMetadatasProvider.class,
           hint="eugene")
public class EugeneCoreTagValues
extends DefaultTagValueMetadatasProvider

Created on 24/09/16. Defines all tag values managed by Eugene. In another library using eugene, please extends this contract to put your own tag values, to get a unique place where to find tag values.

Since:

3.0

Author:

Tony Chemit - dev@tchemit.fr

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EugeneCoreTagValues.Store

Field Summary

Fields inherited from class org.nuiton.eugene.models.extension.tagvalue.provider.DefaultTagValueMetadatasProvider

matcher, tagValues

Constructor Summary

Constructors

Constructor	Description
EugeneCoreTagValues()

Method Summary

Modifier and Type	Method	Description
String	getAttributeGenericTagValue(ObjectModelAttribute attribute)	Obtain the value of the EugeneCoreTagValues.Store.attributeGeneric tag value on the given attribute.
String	getConstantPrefixTagValue(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model)	Obtain the value of the EugeneCoreTagValues.Store.constantPrefix tag value on the given model or classifier.
Set<String>	getConstants(ObjectModelClassifier classifier)	Get tag value EugeneCoreTagValues.Store.constants on given classifier.
String	getDefaultPackage(ObjectModelElement element)	Obtain the value of the EugeneCoreTagValues.Store.defaultPackage tag value on the given element.
static String	getDefaultValue(ObjectModelAttribute attribute)	Check if the given attribute has the EugeneCoreTagValues.Store.defaultValue boolean tag value.
String	getDescription()
String	getDocumentationTagValue(ObjectModel model)	Obtain the value of the EugeneCoreTagValues.Store.documentation tag value on the given model.
String	getDocumentationTagValue(ObjectModelElement element)	Obtain the value of the EugeneCoreTagValues.Store.documentation tag value on the given element.
String	getDocumentationTagValue(ObjectModelPackage aPackage)	Obtain the value of the EugeneCoreTagValues.Store.documentation tag value on the given package.
String	getI18nPrefixTagValue(ObjectModelElement element, ObjectModelPackage aPackage, ObjectModel model)	Cherche et renvoie le préfixe i18n à utiliser sur cet element, sinon sur le model.
Set<String>	getRelativeNameExcludes(ObjectModel model)	Get tag value EugeneCoreTagValues.Store.relativeNameExcludes on given model.
boolean	isGenerateBooleanGetMethods(ObjectModelClassifier classifier, ObjectModelPackage aPackage, ObjectModel model)	Obtain the value of the EugeneCoreTagValues.Store.generateBooleanGetMethods tag value on the given model, package or classifier.
static boolean	isOrdered(ObjectModelAttribute attribute)	Check if the given attribute has the EugeneCoreTagValues.Store.ordered boolean tag value.
static boolean	isSkip(ObjectModelClassifier classifier, ObjectModelPackage aPackage)	Check if the given classifier has the EugeneCoreTagValues.Store.skip boolean tag value.
static boolean	isSkip(ObjectModelPackage aPackage)	Check if the given package has the EugeneCoreTagValues.Store.skip boolean tag value.
static boolean	isUnique(ObjectModelAttribute attribute)	Check if the given attribute has the EugeneCoreTagValues.Store.unique boolean tag value.
boolean	isUseRelativeName(ObjectModel model)	Obtain the value of the EugeneCoreTagValues.Store.useRelativeName tag value on the given model.

Methods inherited from class org.nuiton.eugene.models.extension.tagvalue.provider.DefaultTagValueMetadatasProvider

getDefinitionForMatcher, getTagValue, getTagValues, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

EugeneCoreTagValues

public EugeneCoreTagValues()

Method Detail

getDescription

public String getDescription()

getDocumentationTagValue

public String getDocumentationTagValue(ObjectModel model)

Obtain the value of the EugeneCoreTagValues.Store.documentation tag value on the given model.

Parameters:

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.3

See Also:

EugeneCoreTagValues.Store.documentation

getDocumentationTagValue

public String getDocumentationTagValue(ObjectModelElement element)

Obtain the value of the EugeneCoreTagValues.Store.documentation tag value on the given element.

Parameters:

element - element to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.3

See Also:

EugeneCoreTagValues.Store.documentation

getDocumentationTagValue

public String getDocumentationTagValue(ObjectModelPackage aPackage)

Obtain the value of the EugeneCoreTagValues.Store.documentation tag value on the given package.

Parameters:

aPackage - package to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.12

See Also:

EugeneCoreTagValues.Store.documentation

getI18nPrefixTagValue

public String getI18nPrefixTagValue(ObjectModelElement element,
                                    ObjectModelPackage aPackage,
                                    ObjectModel model)

Cherche et renvoie le préfixe i18n à utiliser sur cet element, sinon sur le model.

Parameters:

element - element to seek

aPackage - package to seek

model - model to seek

Returns:

le préfixe i18n ou null si non spécifié

Since:

2.3

isGenerateBooleanGetMethods

public boolean isGenerateBooleanGetMethods(ObjectModelClassifier classifier,
                                           ObjectModelPackage aPackage,
                                           ObjectModel model)

Obtain the value of the EugeneCoreTagValues.Store.generateBooleanGetMethods tag value on the given model, package or classifier. It will first look on the model, then on package and then in the given classifier.

Parameters:

classifier - classifier to seek

aPackage - package to seek

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.12

See Also:

EugeneCoreTagValues.Store.generateBooleanGetMethods

getConstantPrefixTagValue

public String getConstantPrefixTagValue(ObjectModelClassifier classifier,
                                        ObjectModelPackage aPackage,
                                        ObjectModel model)

Obtain the value of the EugeneCoreTagValues.Store.constantPrefix tag value on the given model or classifier. It will first look on the model, and then in the given classifier.

Parameters:

classifier - classifier to seek

aPackage - package to seek

model - model to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.3

See Also:

EugeneCoreTagValues.Store.constantPrefix

getAttributeGenericTagValue

public String getAttributeGenericTagValue(ObjectModelAttribute attribute)

Obtain the value of the EugeneCoreTagValues.Store.attributeGeneric tag value on the given attribute.

Parameters:

attribute - attribute to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

3.0

See Also:

EugeneCoreTagValues.Store.attributeGeneric

isOrdered

public static boolean isOrdered(ObjectModelAttribute attribute)

Check if the given attribute has the EugeneCoreTagValues.Store.ordered boolean tag value.

Parameters:

attribute - attribute to test

Returns:

true if boolean tag value was found, false otherwise

Since:

2.9

See Also:

EugeneCoreTagValues.Store.ordered

isUnique

public static boolean isUnique(ObjectModelAttribute attribute)

Check if the given attribute has the EugeneCoreTagValues.Store.unique boolean tag value.

Parameters:

attribute - attribute to test

Returns:

true if boolean tag value was found, false otherwise

Since:

2.9

See Also:

EugeneCoreTagValues.Store.unique

getDefaultValue

public static String getDefaultValue(ObjectModelAttribute attribute)

Check if the given attribute has the EugeneCoreTagValues.Store.defaultValue boolean tag value.

Parameters:

attribute - attribute to test

Returns:

default value or null if not found.

Since:

3.0

See Also:

EugeneCoreTagValues.Store.defaultValue

isSkip

public static boolean isSkip(ObjectModelClassifier classifier,
                             ObjectModelPackage aPackage)

Check if the given classifier has the EugeneCoreTagValues.Store.skip boolean tag value.

Parameters:

classifier - classifier to test

aPackage - package to test

Returns:

true if boolean tag value was found, false otherwise

Since:

2.9

See Also:

EugeneCoreTagValues.Store.skip

isSkip

public static boolean isSkip(ObjectModelPackage aPackage)

Check if the given package has the EugeneCoreTagValues.Store.skip boolean tag value.

Parameters:

aPackage - package to test

Returns:

true if boolean tag value was found, false otherwise

See Also:

EugeneCoreTagValues.Store.skip

getDefaultPackage

public String getDefaultPackage(ObjectModelElement element)

Obtain the value of the EugeneCoreTagValues.Store.defaultPackage tag value on the given element.

Parameters:

element - element to seek

Returns:

the none empty value of the found tag value or null if not found nor empty.

Since:

2.3

See Also:

EugeneCoreTagValues.Store.defaultPackage

getConstants

public Set<String> getConstants(ObjectModelClassifier classifier)

Get tag value EugeneCoreTagValues.Store.constants on given classifier.

Parameters:

classifier - classifier to test

Returns:

null if tag value was not found, set of constants to create.

See Also:

EugeneCoreTagValues.Store.constants

isUseRelativeName

public boolean isUseRelativeName(ObjectModel model)

Obtain the value of the EugeneCoreTagValues.Store.useRelativeName tag value on the given model.

Parameters:

model - model to seek

Returns:

true the none empty value of the found tag value or false if not found nor empty.

Since:

3.0

See Also:

EugeneCoreTagValues.Store.useRelativeName

getRelativeNameExcludes

public Set<String> getRelativeNameExcludes(ObjectModel model)

Get tag value EugeneCoreTagValues.Store.relativeNameExcludes on given model.

Parameters:

model - model to seek

Returns:

null if tag value was not found, set of relative name exclude.

See Also:

EugeneCoreTagValues.Store.relativeNameExcludes