Add localization support

AB-xdev · AB-xdev · commit 5d303d29a3fa · 2024-10-07T15:29:29.000+02:00
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/AddFilterComponentsButtons.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/AddFilterComponentsButtons.java
@@ -36,6 +36,7 @@ public AddFilterComponentsButtons()
 	}
 	
 	public void update(
+		final GridFilterLocalizationConfig localizationConfig,
 		final Collection<FilterComponentSupplier> filterComponentSuppliers,
 		final Consumer<FilterComponentSupplier> onAddButtonClicked,
 		final int nestedDepth,
@@ -46,7 +47,10 @@ public void update(
 			.filter(s -> nestedDepth < maxNestedDepth || !s.canCreateNested())
 			.map(s -> {
 				final Button btn =
-					new Button(s.display(), VaadinIcon.PLUS.create(), ev -> onAddButtonClicked.accept(s));
+					new Button(
+						localizationConfig.getTranslation(s.displayKey(), this),
+						VaadinIcon.PLUS.create(),
+						ev -> onAddButtonClicked.accept(s));
 				btn.addThemeVariants(ButtonVariant.LUMO_SMALL);
 				btn.addClassNames(GridFilterStyles.ADD_FILTER_COMPONENTS_BUTTONS_BUTTON);
 				return btn;
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/FilterableField.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/FilterableField.java
@@ -20,17 +20,15 @@
 
 public record FilterableField<I, T>(
 	String name,
+	String identifier,
 	Function<I, T> keyExtractor,
 	Class<T> clazz)
 {
-	public String identifier()
+	public FilterableField
 	{
-		return this.name().chars()
-			.filter(c -> Character.isLetter(c) || Character.isDigit(c))
-			.collect(
-				() -> new StringBuilder(this.name().length()),
-				StringBuilder::appendCodePoint,
-				StringBuilder::append)
-			.toString();
+		if(this.name().chars().anyMatch(c -> !Character.isLetter(c) && !Character.isDigit(c)))
+		{
+			throw new IllegalArgumentException("identifier needs to be alphanumeric");
+		}
 	}
 }
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/GridFilter.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/GridFilter.java
@@ -86,8 +86,8 @@ public class GridFilter<T>
 		new HashMap<>();
 	protected final List<FilterComponentSupplier> filterComponentSuppliers = new ArrayList<>();
 	protected final List<FilterableField<T, ?>> filterableFields = new ArrayList<>();
-	
 	protected int maxNestedDepth = 10;
+	protected GridFilterLocalizationConfig localizationConfig = new GridFilterLocalizationConfig();
 	
 	protected final Map<Operation<?>, List<TypeValueComponentProvider<?>>> cacheOperationTypeValueComponents =
 		Collections.synchronizedMap(new LinkedHashMap<>());
@@ -116,6 +116,7 @@ public GridFilter(final Grid<T> grid)
 	public FilterComponent<T, ?> addFilterComponent(final FilterComponentSupplier supplier)
 	{
 		final FilterComponent<T, ?> filterComponent = supplier.create(
+			this.localizationConfig,
 			this.filterableFields,
 			this::getForField,
 			this.valueReUseAdapters,
@@ -153,6 +154,7 @@ public FilterChangedEvent(final GridFilter<T> source, final boolean fromClient)
 	protected void onAttach(final AttachEvent attachEvent)
 	{
 		this.addFilterComponentButtons.update(
+			this.localizationConfig,
 			this.filterComponentSuppliers,
 			this::addFilterComponent,
 			START_DEPTH,
@@ -313,7 +315,17 @@ public <S> GridFilter<T> withFilterableField(
 		final Function<T, S> keyExtractor,
 		final Class<S> clazz)
 	{
-		this.filterableFields.add(new FilterableField<>(name, keyExtractor, clazz));
+		final String identifier
+		return this.withFilterableField(name, null, keyExtractor, clazz);
+	}
+	
+	public <S> GridFilter<T> withFilterableField(
+		final String name,
+		final String identifier,
+		final Function<T, S> keyExtractor,
+		final Class<S> clazz)
+	{
+		this.filterableFields.add(new FilterableField<>(name, identifier, keyExtractor, clazz));
 		return this;
 	}
 	
@@ -327,6 +339,12 @@ public GridFilter<T> withMaxNestedDepth(final int maxNestedDepth)
 		return this;
 	}
 	
+	public GridFilter<T> withLocalizationConfig(final GridFilterLocalizationConfig localizationConfig)
+	{
+		this.localizationConfig = localizationConfig;
+		return this;
+	}
+	
 	// endregion
 	
 	public static <T> GridFilter<T> createDefault(final Grid<T> grid)
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/GridFilterLocalizationConfig.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/GridFilterLocalizationConfig.java
@@ -0,0 +1,82 @@
+package software.xdev.vaadin.gridfilter;
+
+import static java.util.Map.entry;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.function.BiFunction;
+
+import com.vaadin.flow.component.Component;
+
+
+public class GridFilterLocalizationConfig
+{
+	public static final String PREFIX = "gridfilter.";
+	
+	public static final String PREFIX_OP = PREFIX + "op.";
+	public static final String OP_EQUALS = PREFIX_OP + "equals";
+	public static final String OP_CONTAINS = PREFIX_OP + "contains";
+	public static final String OP_GREATER_THAN = PREFIX_OP + "gt";
+	public static final String OP_LESS_THAN = PREFIX_OP + "lt";
+	public static final String OP_IS_EMPTY = PREFIX_OP + "empty";
+	
+	public static final String PREFIX_BLOCK = PREFIX + "block.";
+	public static final String BLOCK_OR = PREFIX_BLOCK + "or";
+	public static final String BLOCK_AND = PREFIX_BLOCK + "and";
+	public static final String BLOCK_NOT = PREFIX_BLOCK + "not";
+	public static final String CONDITION = PREFIX + "condition";
+	
+	// Key, Default Value
+	public static final Map<String, String> DEFAULT_VALUES = Map.ofEntries(
+		// Operation
+		entry(OP_EQUALS, "="),
+		entry(OP_CONTAINS, "contains"),
+		entry(OP_GREATER_THAN, ">"),
+		entry(OP_LESS_THAN, "<"),
+		entry(OP_IS_EMPTY, "is empty"),
+		// Block
+		entry(BLOCK_OR, "OR"),
+		entry(BLOCK_AND, "AND"),
+		entry(BLOCK_NOT, "NOT"),
+		entry(CONDITION, "condition")
+	);
+	
+	// Key, Resolver
+	protected final Map<String, BiFunction<Component, String, String>> keyResolvers = new HashMap<>();
+	
+	public GridFilterLocalizationConfig withAll(final Map<String, String> keyValues)
+	{
+		keyValues.forEach(this::with);
+		return this;
+	}
+	
+	public GridFilterLocalizationConfig with(final String key, final String value)
+	{
+		this.getKeyResolvers().put(key, (c, k) -> value);
+		return this;
+	}
+	
+	public GridFilterLocalizationConfig withTranslation(final String key, final String i18nKey)
+	{
+		this.getKeyResolvers().put(
+			key,
+			(c, k) -> c.getTranslation(i18nKey));
+		return this;
+	}
+	
+	public String getTranslation(final String key, final Component caller)
+	{
+		final BiFunction<Component, String, String> resolver = this.getKeyResolvers().get(key);
+		if(resolver == null)
+		{
+			final String defaultValue = DEFAULT_VALUES.get(key);
+			return defaultValue != null ? defaultValue : key;
+		}
+		return resolver.apply(caller, key);
+	}
+	
+	public Map<String, BiFunction<Component, String, String>> getKeyResolvers()
+	{
+		return this.keyResolvers;
+	}
+}
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/ContainsOp.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/ContainsOp.java
@@ -15,14 +15,15 @@
  */
 package software.xdev.vaadin.gridfilter.business.operation;
 
+import software.xdev.vaadin.gridfilter.GridFilterLocalizationConfig;
 import software.xdev.vaadin.gridfilter.business.value.SingleValue;
 
 
 public class ContainsOp extends SingleValueOperation<String>
 {
 	public ContainsOp()
 	{
-		super(String.class, "contains");
+		super(String.class, "contains", GridFilterLocalizationConfig.OP_CONTAINS);
 	}
 	
 	@Override
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/EqualsOp.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/EqualsOp.java
@@ -17,14 +17,15 @@
 
 import java.util.Objects;
 
+import software.xdev.vaadin.gridfilter.GridFilterLocalizationConfig;
 import software.xdev.vaadin.gridfilter.business.value.SingleValue;
 
 
 public class EqualsOp extends SingleValueOperation<Object>
 {
 	public EqualsOp()
 	{
-		super(Object.class, "=");
+		super(Object.class, "=", GridFilterLocalizationConfig.OP_EQUALS);
 	}
 	
 	@Override
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/GreaterThanOp.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/GreaterThanOp.java
@@ -15,6 +15,7 @@
  */
 package software.xdev.vaadin.gridfilter.business.operation;
 
+import software.xdev.vaadin.gridfilter.GridFilterLocalizationConfig;
 import software.xdev.vaadin.gridfilter.business.value.SingleValue;
 
 
@@ -23,7 +24,7 @@ public class GreaterThanOp extends SingleValueComparableOperation
 {
 	public GreaterThanOp()
 	{
-		super(">");
+		super(">", GridFilterLocalizationConfig.OP_GREATER_THAN);
 	}
 	
 	@SuppressWarnings("unchecked")
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/IsEmptyOp.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/IsEmptyOp.java
@@ -15,6 +15,7 @@
  */
 package software.xdev.vaadin.gridfilter.business.operation;
 
+import software.xdev.vaadin.gridfilter.GridFilterLocalizationConfig;
 import software.xdev.vaadin.gridfilter.business.value.NoValue;
 
 
@@ -38,6 +39,12 @@ public String identifier()
 		return "is empty";
 	}
 	
+	@Override
+	public String displayKey()
+	{
+		return GridFilterLocalizationConfig.OP_IS_EMPTY;
+	}
+	
 	@Override
 	public boolean test(final Object input, final NoValue filterValue)
 	{
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/LessThanOp.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/LessThanOp.java
@@ -15,6 +15,7 @@
  */
 package software.xdev.vaadin.gridfilter.business.operation;
 
+import software.xdev.vaadin.gridfilter.GridFilterLocalizationConfig;
 import software.xdev.vaadin.gridfilter.business.value.SingleValue;
 
 
@@ -23,7 +24,7 @@ public class LessThanOp extends SingleValueComparableOperation
 {
 	public LessThanOp()
 	{
-		super("<");
+		super("<", GridFilterLocalizationConfig.OP_LESS_THAN);
 	}
 	
 	@SuppressWarnings("unchecked")
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/Operation.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/Operation.java
@@ -26,6 +26,8 @@ public interface Operation<V extends ValueContainer>
 	
 	String identifier();
 	
+	String displayKey();
+	
 	boolean test(Object input, V filterValue);
 	
 	@SuppressWarnings("unchecked")
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/SingleValueComparableOperation.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/SingleValueComparableOperation.java
@@ -18,9 +18,9 @@
 @SuppressWarnings("rawtypes")
 public abstract class SingleValueComparableOperation extends SingleValueOperation<Comparable>
 {
-	protected SingleValueComparableOperation(final String display)
+	protected SingleValueComparableOperation(final String identifier, final String display)
 	{
-		super(Comparable.class, display);
+		super(Comparable.class, identifier, display);
 	}
 	
 	@Override
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/SingleValueOperation.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/business/operation/SingleValueOperation.java
@@ -23,11 +23,13 @@
 public abstract class SingleValueOperation<C> implements Operation<SingleValue<C>>
 {
 	protected final Class<C> supportedClass;
-	protected final String display; // TODO: I18N System like Grid Exporter
+	protected final String identifier;
+	protected final String display;
 	
-	protected SingleValueOperation(final Class<C> supported, final String display)
+	protected SingleValueOperation(final Class<C> supported, final String identifier, final String display)
 	{
 		this.supportedClass = Objects.requireNonNull(supported);
+		this.identifier = Objects.requireNonNull(identifier);
 		this.display = Objects.requireNonNull(display);
 	}
 	
@@ -45,6 +47,12 @@ public boolean canHandle(final Class<?> clazz)
 	
 	@Override
 	public String identifier()
+	{
+		return this.identifier;
+	}
+	
+	@Override
+	public String displayKey()
 	{
 		return this.display;
 	}
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/FilterComponentSupplier.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/FilterComponentSupplier.java
@@ -21,6 +21,7 @@
 import java.util.function.Function;
 
 import software.xdev.vaadin.gridfilter.FilterableField;
+import software.xdev.vaadin.gridfilter.GridFilterLocalizationConfig;
 import software.xdev.vaadin.gridfilter.business.operation.Operation;
 import software.xdev.vaadin.gridfilter.business.typevaluecomp.TypeValueComponentProvider;
 import software.xdev.vaadin.gridfilter.business.value.ValueContainer;
@@ -29,14 +30,15 @@
 
 public interface FilterComponentSupplier
 {
-	String display(); // TODO I18N
+	String displayKey();
 	
 	String serializationPrefix();
 	
 	boolean canCreateNested();
 	
 	@SuppressWarnings("java:S1452")
 	<T> FilterComponent<T, ?> create(
+		GridFilterLocalizationConfig localizationConfig,
 		List<FilterableField<T, ?>> filterableFields,
 		Function<FilterableField<T, ?>, Map<Operation<?>, TypeValueComponentProvider<?>>> fieldDataResolver,
 		Map<Class<? extends ValueContainer>, Set<ValueReUseAdapter<?>>> valueReUseAdapters,
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/block/FilterANDComponentSupplier.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/block/FilterANDComponentSupplier.java
@@ -18,15 +18,16 @@
 import java.util.function.Predicate;
 import java.util.stream.Stream;
 
+import software.xdev.vaadin.gridfilter.GridFilterLocalizationConfig;
 import software.xdev.vaadin.gridfilter.filtercomponents.FilterComponent;
 
 
 public class FilterANDComponentSupplier extends FilterBlockComponentSupplier
 {
 	@Override
-	public String display()
+	public String displayKey()
 	{
-		return "AND";
+		return GridFilterLocalizationConfig.BLOCK_AND;
 	}
 	
 	@Override
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/block/FilterBlockComponent.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/block/FilterBlockComponent.java
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/block/FilterBlockComponentSupplier.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/block/FilterBlockComponentSupplier.java
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/block/FilterNOTComponentSupplier.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/block/FilterNOTComponentSupplier.java
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/block/FilterORComponentSupplier.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/block/FilterORComponentSupplier.java
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/condition/FieldFilterConditionComponent.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/condition/FieldFilterConditionComponent.java
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/condition/FieldFilterConditionComponentSupplier.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/condition/FieldFilterConditionComponentSupplier.java

Original file line number	Diff line number	Diff line change
`@@ -20,17 +20,15 @@`
`20`	`20`
`21`	`21`	`public record FilterableField<I, T>(`
`22`	`22`	`String name,`
	`23`	`+ String identifier,`
`23`	`24`	`Function<I, T> keyExtractor,`
`24`	`25`	`Class<T> clazz)`
`25`	`26`	`{`
`26`		`- public String identifier()`
	`27`	`+ public FilterableField`
`27`	`28`	`{`
`28`		`- return this.name().chars()`
`29`		`- .filter(c -> Character.isLetter(c) \|\| Character.isDigit(c))`
`30`		`- .collect(`
`31`		`- () -> new StringBuilder(this.name().length()),`
`32`		`- StringBuilder::appendCodePoint,`
`33`		`- StringBuilder::append)`
`34`		`- .toString();`
	`29`	`+ if(this.name().chars().anyMatch(c -> !Character.isLetter(c) && !Character.isDigit(c)))`
	`30`	`+ {`
	`31`	`+ throw new IllegalArgumentException("identifier needs to be alphanumeric");`
	`32`	`+ }`
`35`	`33`	`}`
`36`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,14 +15,15 @@`
`15`	`15`	`*/`
`16`	`16`	`package software.xdev.vaadin.gridfilter.business.operation;`
`17`	`17`
	`18`	`+import software.xdev.vaadin.gridfilter.GridFilterLocalizationConfig;`
`18`	`19`	`import software.xdev.vaadin.gridfilter.business.value.SingleValue;`
`19`	`20`
`20`	`21`
`21`	`22`	`public class ContainsOp extends SingleValueOperation<String>`
`22`	`23`	`{`
`23`	`24`	`public ContainsOp()`
`24`	`25`	`{`
`25`		`- super(String.class, "contains");`
	`26`	`+ super(String.class, "contains", GridFilterLocalizationConfig.OP_CONTAINS);`
`26`	`27`	`}`
`27`	`28`
`28`	`29`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -17,14 +17,15 @@`
`17`	`17`
`18`	`18`	`import java.util.Objects;`
`19`	`19`
	`20`	`+import software.xdev.vaadin.gridfilter.GridFilterLocalizationConfig;`
`20`	`21`	`import software.xdev.vaadin.gridfilter.business.value.SingleValue;`
`21`	`22`
`22`	`23`
`23`	`24`	`public class EqualsOp extends SingleValueOperation<Object>`
`24`	`25`	`{`
`25`	`26`	`public EqualsOp()`
`26`	`27`	`{`
`27`		`- super(Object.class, "=");`
	`28`	`+ super(Object.class, "=", GridFilterLocalizationConfig.OP_EQUALS);`
`28`	`29`	`}`
`29`	`30`
`30`	`31`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`*/`
`16`	`16`	`package software.xdev.vaadin.gridfilter.business.operation;`
`17`	`17`
	`18`	`+import software.xdev.vaadin.gridfilter.GridFilterLocalizationConfig;`
`18`	`19`	`import software.xdev.vaadin.gridfilter.business.value.SingleValue;`
`19`	`20`
`20`	`21`
`@@ -23,7 +24,7 @@ public class GreaterThanOp extends SingleValueComparableOperation`
`23`	`24`	`{`
`24`	`25`	`public GreaterThanOp()`
`25`	`26`	`{`
`26`		`- super(">");`
	`27`	`+ super(">", GridFilterLocalizationConfig.OP_GREATER_THAN);`
`27`	`28`	`}`
`28`	`29`
`29`	`30`	`@SuppressWarnings("unchecked")`