Changeset 2828

Timestamp:

04/23/13 13:56:54 (11 years ago)

Author:

keeloo

Message:

Added support for search page type of resources.

Location:

vlo/trunk/vlo_importer/src/main/java/eu/clarin/cmdi/vlo

Files:

• FacetConstants.java (modified) (3 diffs)
• Resources.java (modified) (3 diffs)
• importer/CMDIData.java (modified) (5 diffs)
• importer/MetadataImporter.java (modified) (1 diff)

vlo/trunk/vlo_importer/src/main/java/eu/clarin/cmdi/vlo/FacetConstants.java

@@ -4 +4 @@
 
 /**
- * A bunch of important constants.
- * Constants for each facet, resource types and some urls.
+ * Definition of facet, resource type and URL constants.
  */
 public class FacetConstants {
@@ -33 +32 @@
     public static final String FIELD_CLARIN_PROFILE = "_componentProfile";
     public static final String FIELD_SEARCH_SERVICE = "_contentSearchRef";
+    
+    /** Facet constant associated with the landing page type. */
     public static final String FIELD_LANDINGPAGE = "_landingPageRef";
+    /** Facet constant associated with the search page type. */
+    public static final String FIELD_SEARCHPAGE = "_searchPageRef";
     
     // PREFIX URL for the language-link    
@@ -50 +53 @@
     public static final String FIELD_RESOURCE_SPLIT_CHAR = "|";
     public static final String URN_NBN_PREFIX = "urn:nbn";
-
 }

vlo/trunk/vlo_importer/src/main/java/eu/clarin/cmdi/vlo/Resources.java

@@ +1 @@
+
 package eu.clarin.cmdi.vlo;
 
 /**
- * Definition of keys to message texts.<br><br>
+ * Definition of keys to message texts.
  * 
  * Please note that value of a key defined in this class is defined in the
@@ -8 +9 @@
  * pages that are subject to Wicket, for example:<br><br>
  *
- * {@literal <div class="resourceList"><span>}
- * {@literal    <wicket:message key="resources">[Resources]</wicket:message>:</span>}
- * .
- * .
- * .
+ * {@literal <div class="resourceList"><span>}<br>
+ * .<br>
+ * .<br>
+ * {@literal <wicket:message key="resources">}<br>
+ * {@literal [Resources]}<br>
+ * {@literal </wicket:message>:</span>}<br>
+ * .<br>
+ * .<br>
  * {@literal </div>}
  */
@@ -25 +29 @@
     public static final String OPEN_IN_ORIGINAL_CONTEXT = "openInOriginalContext";
     public static final String ORIGINAL_CONTEXT_NOT_AVAILABLE = "originalContextNotAvailable";  
-
-    // keys to text used in labels in the page showing search result
+    
+    /** Key to a text on the result page labeling a single landing page. */
     public static final String LANDING_PAGE = "landingPage";    
+    /** Key to a text on the result page labeling s list of landing pages. */
     public static final String LANDING_PAGES = "landingPages";    
+    /** Key to a text on the result page labeling a single search page. */
+    public static final String SEARCH_PAGE = "searchPage";    
+    /** Key to a text on the result page labeling a list of search pages.*/
+    public static final String SEARCH_PAGES = "searchPages";    
 }

vlo/trunk/vlo_importer/src/main/java/eu/clarin/cmdi/vlo/importer/CMDIData.java

@@ -10 +10 @@
 
 /**
- * Represents a document of cmdi data.
- * Quite a central class to the metadata importer process.
+ * Represents a document of CMDI data.
  */
-
 public class CMDIData {
     private final static Logger LOG = LoggerFactory.getLogger(CMDIData.class);
@@ -19 +17 @@
     private static final String DATA_RESOURCE_TYPE = "Resource";
     private static final String SEARCH_SERVICE_TYPE = "SearchService";
+    //* Definition of the string denoting the landing page type. */
     private static final String LANDING_PAGE_TYPE = "LandingPage";
+    //* Definition of the string denoting the search page type. */
+    private static final String SEARCH_PAGE_TYPE = "SearchPage";
 
     /**
@@ -36 +37 @@
     private final List<Resource> searchResources = new ArrayList<Resource>();
     private final List<Resource> landingPageResources = new ArrayList<Resource>();
+    private final List<Resource> searchPageResources = new ArrayList<Resource>();
 
     public SolrInputDocument getSolrDocument() {
@@ -94 +96 @@
 
     /**
-     * Return a list of landing page resources
+     * Return the list of landing page resources.
+     * 
+     * @return the list
      */
     public List<Resource> getLandingPageResources() {
         return landingPageResources;
     }
+    
+    /**
+     * Return the  list of search page resources.
+     * 
+     * @return the list
+     */
+    public List<Resource> getSearchPageResources() {
+        return searchPageResources;
+    }
 
     /**
-     * Processes a resource by adding it to the internal lists. Supports meta
-     * data, data, search service and landing page type of resources. Emits a
-     * warning if another type of resource is encountered (not allowed according
-     * to the cmdi spec, but we try to be a tad robust).
+     * Add a meta data resource to the list of resources of that type.
+     * 
+     * Whenever the type is not one of a type supported by the CMDI
+     * specification, a warning is logged.
      *
-     * @param resource
-     * @param type
-     * @param mimeType
+     * @param resource meta data resource
+     * @param type type of the resource
+     * @param mimeType mime type associated with the resource
      */
     public void addResource(String resource, String type, String mimeType) {
@@ -119 +132 @@
         } else if (LANDING_PAGE_TYPE.equals(type)){
             landingPageResources.add(new Resource(resource,type, mimeType));
+        } else if (SEARCH_PAGE_TYPE.equals(type)){
+            searchPageResources.add(new Resource(resource,type, mimeType));
         } else {
-            LOG.warn("Found unsupported resource it will be ignored: type=" + 
+            LOG.warn("Ignoring unsupported resource type " + 
                     type + ", name=" + resource);
         }

vlo/trunk/vlo_importer/src/main/java/eu/clarin/cmdi/vlo/importer/MetadataImporter.java

@@ -310 +310 @@
         }
         
+        // add search page resource
+        for (Resource resource : cmdiData.getSearchPageResources()) {
+            solrDocument.addField(FacetConstants.FIELD_SEARCHPAGE, resource.getResourceName());
+        }
+        
         addResourceData(solrDocument, cmdiData);
         docs.add(solrDocument);