Add Project Keywords to API and search; (DOECODE-645)

Author: sowerstl

schema.xml

@@ -469,6 +469,7 @@
   <field name="doi" type="string"/>
   <field name="doiStatus" type="string" indexed="true" stored="true"/>
   <field name="keywords" type="text_general" indexed="true"/>
+  <field name="projectKeywords" type="text_general" multiValued="true" indexed="true" stored="true"/>
   <field name="licenses" type="string" multiValued="true" indexed="true" stored="true"/>
   <field name="openSource" type="boolean" default="false" indexed="true" stored="true"/>
   <field name="otherSpecialRequirements" type="strings"/>

src/main/java/gov/osti/entity/DOECodeMetadata.java

@@ -202,6 +202,11 @@ public String label() {
     private String documentationUrl = null;
     private String countryOfOrigin = null;
     private String keywords = null;
+
+    @JacksonXmlElementWrapper (localName = "projectKeywords")
+    @JacksonXmlProperty (localName = "projectKeyword")
+    private List<String> projectKeywords;
+
     private String disclaimers = null;
 
     @JacksonXmlElementWrapper (localName = "licenses")
@@ -458,6 +463,20 @@ public String getKeywords() {
     public void setKeywords(String keywords) {
             this.keywords = keywords;
     }
+
+    @ElementCollection
+    @CollectionTable(
+            name = "PROJECT_KEYWORDS",
+            joinColumns=@JoinColumn(name="CODE_ID")
+    )
+    @Column (name = "PROJECT_KEYWORD")
+    public List<String> getProjectKeywords() {
+            return projectKeywords;
+    }
+    public void setProjectKeywords(List<String> projectKeywords) {
+            this.projectKeywords = projectKeywords;
+    }
+
     @Size (max = 3000, message = "Disclaimers are limited to 3000 characters.")
     @Column (length = 3000)
     public String getDisclaimers() {

src/main/java/gov/osti/search/SearchData.java

@@ -44,6 +44,7 @@ public class SearchData implements Serializable {
     private String[] accessibility = null;
     private String[] programmingLanguages;
     private String keywords;
+    private String[] projectKeywords;
     private String[] licenses;
     private String[] researchOrganization = null;
     private String[] sponsoringOrganization = null;
@@ -235,6 +236,17 @@ public String toQ() {
             if (q.length()>0) q.append(" ");
             q.append("keywords:(").append(escape(getKeywords())).append(")");
         }
+        if (null!=getProjectKeywords()) {
+            StringBuilder values = new StringBuilder();
+            for ( String projectKeyword : getProjectKeywords() ) {
+                if (values.length()>0) values.append(" OR ");
+                values.append("projectKeywords:\"").append(escapeToken(projectKeyword)).append("\"");
+            }
+            if (values.length()>0) {
+                if (q.length()>0) q.append(" ");
+                q.append("(").append(values.toString()).append(")");
+            }
+        }
         if (null!=getLicenses()) {
             StringBuilder values = new StringBuilder();
             for ( String license : getLicenses() ) {
@@ -384,6 +396,20 @@ public String getKeywords() {
         return this.keywords;
     }
 
+    /**
+     * @return the project keywords
+     */
+    public String[] getProjectKeywords() {
+        return projectKeywords;
+    }
+
+    /**
+     * @param projectKeywords the project keywords to set
+     */
+    public void setProjectKeywords(String[] projectKeywords) {
+        this.projectKeywords = projectKeywords;
+    }
+
     /**
      * @return the softwareType
      */

src/main/java/gov/osti/services/Metadata.java

@@ -744,6 +744,11 @@ private void store(EntityManager em, DOECodeMetadata md, User user) throws NotFo
         ValidatorFactory validators = javax.validation.Validation.buildDefaultValidatorFactory();
         Validator validator = validators.getValidator();
 
+        // must be OSTI user in order to add/update PROJECT KEYWORDS
+        List<String> projectKeywords = md.getProjectKeywords();
+        if (projectKeywords != null && !projectKeywords.isEmpty() && !user.hasRole("OSTI"))
+            throw new ValidationException("Project Keywords can only be set by authorized users.");
+
         // if there's a CODE ID, attempt to look up the record first and
         // copy attributes into it
         if ( null==md.getCodeId() || 0==md.getCodeId()) {