Changeset 6046

Timestamp:

02/25/15 08:28:47 (9 years ago)

Author:

Twan Goosen

Message:

Changed strategy for removing language code prefix from descriptions: now using field value converter. This does away with the DescriptionFieldModel?. Converter now also used in SOLR field labels for multiple values. Removed some unused constructors & moved a regex constant into FacetConstants?
refs #699

Location:

vlo/trunk

Files:

• vlo-commons/src/main/java/eu/clarin/cmdi/vlo/FacetConstants.java (modified) (2 diffs)
• vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/VloWicketApplication.java (modified) (3 diffs)
• vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/components/FieldValueLabel.java (modified) (1 diff)
• vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/components/SmartLinkFieldValueLabel.java (added)
• vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/components/SolrFieldLabel.java (modified) (1 diff)
• vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/model/DescriptionFieldModel.java (deleted)
• vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/model/SolrFieldStringModel.java (modified) (7 diffs)
• vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/panels/record/FieldsTablePanel.java (modified) (5 diffs)
• vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/provider/FieldValueConverterProviderImpl.java (modified) (6 diffs)

vlo/trunk/vlo-commons/src/main/java/eu/clarin/cmdi/vlo/FacetConstants.java

@@ -43 +43 @@
      */
     public static final String FIELD_SEARCHPAGE = "_searchPageRef";
-    
+
     //Deprecated fields
     public static final String DEPRECATED_FIELD_LANGUAGE = "language";
@@ -71 +71 @@
      */
     public static final String DESCRIPTION_LANGUAGE_PATTERN = "^\\{lang='([a-z]{3})'\\}";
+
+    /**
+     * regular expression that matches the syntax of the 'languageCode' field
+     * (with either a language code or a name as indicated by the prefix)
+     */
+    public static final String LANGUAGE_CODE_PATTERN = "(name|code):(.*)";
 }

vlo/trunk/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/VloWicketApplication.java

@@ -10 +10 @@
 import eu.clarin.cmdi.vlo.wicket.pages.SimpleSearchPage;
 import eu.clarin.cmdi.vlo.wicket.pages.VloBasePage;
+import eu.clarin.cmdi.vlo.wicket.provider.FieldValueConverterProvider;
 import javax.inject.Inject;
 import org.apache.wicket.Application;
@@ -37 +38 @@
     @Inject
     private XmlTransformationService cmdiTransformationService;
+    @Inject
+    private FieldValueConverterProvider fieldValueConverterProvider;
     @Inject
     private VloConfig vloConfig;
@@ -145 +148 @@
         return cmdiTransformationService;
     }
+    
+    public FieldValueConverterProvider getFieldValueConverterProvider() {
+        return fieldValueConverterProvider;
+    }
 
 }

vlo/trunk/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/components/FieldValueLabel.java

@@ -19 +19 @@
 import eu.clarin.cmdi.vlo.wicket.provider.FieldValueConverterProvider;
 import eu.clarin.cmdi.vlo.wicket.provider.FieldValueConverterProviderImpl;
-import org.apache.solr.client.solrj.response.FacetField;
 import org.apache.wicket.markup.html.basic.Label;
 import org.apache.wicket.model.IModel;

vlo/trunk/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/components/SolrFieldLabel.java

@@ -35 +35 @@
      * @param documentModel model that holds document to show field of
      * @param fieldName name of field to show value of
-     */
-    public SolrFieldLabel(String id, IModel<SolrDocument> documentModel, String fieldName) {
-        super(id, new SolrFieldStringModel(documentModel, fieldName));
-    }
-
-    /**
-     *
-     * @param id id of label
-     * @param documentModel model that holds document to show field of
-     * @param fieldName name of field to show value of
-     * @param maxLength maximum length to allow
-     * @param truncatePoint point to truncate if string is too long
-     */
-    public SolrFieldLabel(String id, IModel<SolrDocument> documentModel, String fieldName, int maxLength, int truncatePoint) {
-        super(id,
-                new TruncatingStringModel(
-                        new SolrFieldStringModel(documentModel, fieldName), maxLength, truncatePoint));
-    }
-
-    /**
-     *
-     * @param id id of label
-     * @param documentModel model that holds document to show field of
-     * @param fieldName name of field to show value of
      * @param nullFallback string to show if actual value is null
      */

vlo/trunk/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/model/SolrFieldStringModel.java

@@ -17 +17 @@
 package eu.clarin.cmdi.vlo.wicket.model;
 
-import eu.clarin.cmdi.vlo.FacetConstants;
+import eu.clarin.cmdi.vlo.VloWicketApplication;
 import java.util.Collection;
 import java.util.Iterator;
@@ -23 +23 @@
 import org.apache.wicket.model.AbstractReadOnlyModel;
 import org.apache.wicket.model.IModel;
+import org.apache.wicket.util.convert.IConverter;
 
 /**
@@ -44 +45 @@
      */
     public SolrFieldStringModel(IModel<SolrDocument> documentModel, String fieldName) {
-        fieldModel = new SolrFieldModel<Object>(documentModel, fieldName);
+        fieldModel = new SolrFieldModel<>(documentModel, fieldName);
         field = fieldName;
     }
@@ -60 +61 @@
         final Iterator<Object> iterator = fieldValues.iterator();
         if (iterator.hasNext()) {
-            final String firstValue = postprocessValue(iterator.next().toString());
+            final String firstValue = iterator.next().toString();
             if (iterator.hasNext()) {
                 return getMultipleValuesString(firstValue, iterator);
@@ -72 +73 @@
 
     protected String getMultipleValuesString(final String firstValue, final Iterator<Object> iterator) {
-        final StringBuilder valuesBuilder = new StringBuilder(firstValue).append("; ");
+        // for multiple value strings, run every individual value through the converter
+        final StringBuilder valuesBuilder = new StringBuilder(postprocessValue(firstValue)).append("; ");
         while (iterator.hasNext()) {
-            valuesBuilder.append(iterator.next().toString());
+            valuesBuilder.append(postprocessValue(iterator.next().toString()));
             if (iterator.hasNext()) {
                 valuesBuilder.append("; ");
@@ -90 +92 @@
     private String postprocessValue(String value) {
         if (value != null) {
-            if (FacetConstants.FIELD_DESCRIPTION.equals(field)) {
-                //remove language prefix
-                return value.replaceAll(FacetConstants.DESCRIPTION_LANGUAGE_PATTERN, "");
+            final IConverter<String> converter = getFieldValueConverter();
+            if (converter != null) {
+                return converter.convertToString(value, null);
             }
         }
@@ -98 +100 @@
     }
 
+    private IConverter<String> getFieldValueConverter() {
+        return VloWicketApplication.get().getFieldValueConverterProvider().getConverter(field);
+    }
+
 }

vlo/trunk/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/panels/record/FieldsTablePanel.java

@@ -26 +26 @@
 import eu.clarin.cmdi.vlo.service.PageParametersConverter;
 import eu.clarin.cmdi.vlo.wicket.components.FieldValueLabel;
-import eu.clarin.cmdi.vlo.wicket.model.DescriptionFieldModel;
+import eu.clarin.cmdi.vlo.wicket.components.SmartLinkFieldValueLabel;
 import eu.clarin.cmdi.vlo.wicket.model.HandleLinkModel;
 import eu.clarin.cmdi.vlo.wicket.model.SolrFieldNameModel;
@@ -35 +35 @@
 import org.apache.wicket.AttributeModifier;
 import org.apache.wicket.Component;
-import org.apache.wicket.extensions.markup.html.basic.SmartLinkLabel;
 import org.apache.wicket.extensions.markup.html.basic.SmartLinkMultiLineLabel;
 import org.apache.wicket.markup.html.basic.Label;
@@ -118 +117 @@
     }
 
-    private Component createValueLabel(String id, final IModel<String> facetNameModel, final IModel<String> originalValueModel) {
+    private Component createValueLabel(String id, final IModel<String> facetNameModel, final IModel<String> valueModel) {
         final String fieldName = facetNameModel.getObject();
-
-        // allow for postprocessing or wrapping of the value model depending on the field
-        final IModel<String> valueModel = getValueModel(facetNameModel, originalValueModel);
 
         if (FacetConstants.FIELD_LANGUAGE_CODE.equals(facetNameModel.getObject())) {
@@ -128 +124 @@
         } else if (SMART_LINK_FIELDS.contains(fieldName)) {
             // create label that generates links
-            return new SmartLinkLabel(id, new HandleLinkModel(valueModel));
+            return new SmartLinkFieldValueLabel(id, new HandleLinkModel(valueModel), facetNameModel);
         } else {
             // add a label for the facet value
@@ -164 +160 @@
     }
 
-    private IModel<String> getValueModel(IModel<String> facetNameModel, IModel<String> valueModel) {
-        if (FacetConstants.FIELD_DESCRIPTION.equals(facetNameModel.getObject())) {
-            //wrap in model that removes the language prefix
-            return new DescriptionFieldModel(valueModel);
-        }
-        return valueModel;
-    }
-
 }

vlo/trunk/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/provider/FieldValueConverterProviderImpl.java

@@ -31 +31 @@
 public class FieldValueConverterProviderImpl implements FieldValueConverterProvider {
 
+    private final static Pattern LANGUAGE_CODE_PATTERN = Pattern.compile(FacetConstants.LANGUAGE_CODE_PATTERN);
     private final LanguageCodeUtils languageCodeUtils;
-    private Pattern LANGUAGE_CODE_PATTERN = Pattern.compile("(name|code):(.*)");
 
     public FieldValueConverterProviderImpl(LanguageCodeUtils languageCodeUtils) {
@@ -43 +43 @@
             case FacetConstants.FIELD_LANGUAGE_CODE:
                 return languageCodeConverter;
+            case FacetConstants.FIELD_DESCRIPTION:
+                return descriptionConverter;
             default:
                 return null;
@@ -49 +51 @@
     }
 
+    /**
+     * Abstract base class for one directional string converters
+     */
     private abstract class FieldValueConverter implements IConverter<String> {
 
@@ -58 +63 @@
     }
 
+    /**
+     * Converter for language code/name strings (following the pattern of
+     * {@link #LANGUAGE_CODE_PATTERN}) into language names
+     *
+     * @see LanguageCodeUtils#getLanguageNameForLanguageCode(java.lang.String)
+     */
     private final FieldValueConverter languageCodeConverter = new FieldValueConverter() {
 
@@ -75 +86 @@
                 }
             }
-            
+
             // does not match expected pattern, return original value
             return fieldValue;
@@ -82 +93 @@
     };
 
+    /**
+     * Converter for description field values that strips out any language code
+     * prefix
+     */
+    private final FieldValueConverter descriptionConverter = new FieldValueConverter() {
+
+        @Override
+        public String convertToString(String fieldValue, Locale locale) throws ConversionException {
+            return fieldValue.replaceAll(FacetConstants.DESCRIPTION_LANGUAGE_PATTERN, "");
+        }
+
+    };
+
 }