Customizing search results

public class AuthorField implements SearchResultField {

   @Override
   public String getDisplayName() { 
      return "Author";
   }

   @Override
   public boolean isSupported(ObjectType type) { 
      return true;
   }

   @Override
   public String createDataCellText(Object item) { 
      Article article = State.getInstance(item).getOriginalObject() instanceof Article
             ? ((Article) State.getInstance(item).getOriginalObject()) : null;

      if (article != null) {
         if (article.getAuthor() != null)
            return article.getAuthor().getName();
         else return ("No attribution");
      }
      return null;
   }
}

• Specifies how the field label appears in the search results.
• Determines if the field appears in the search results. If the method returns false, the Author field does not appear in the Select Fields widget.
• Filters for Article objects and returns null if the search result is not an Article. For objects where the Author field is set, the author name is returned; otherwise "No attribution" is returned.

@Override
 public void writeHtml(
         ToolPageContext page,
         Search search,
         SearchResultSelection selection)
         throws IOException {

   page.writeStart("div", "class", "searchResult-action-simple");
       page.writeStart("a",
               "class", "button",
               "target", "toolUserSaveSearch",
               "href", page.cmsUrl("/toolUserSaveSearch", 
                       "search", page.url("", Search.NAME_PARAMETER, null)));
           page.writeHtml(page.localize(SaveSearchResultAction.class, "action.saveSearch")); 
       page.writeEnd();
   page.writeEnd();
 }

• Construct the URL to the page servlet, specified in the servlet routing path as toolUserSaveSearch. This page servlet is located in <project>src/main/java/com/psddev/cms/tool/page.
• Specifies the label on the action button. If Brightspot is localized, you can pass a resource key to retrieve the label for the applicable UI language. For the search result APIs in the Brightspot project, place resource files in <project>src/main/resource/com/psddev/cms/tool/search.

@SearchResultSelectionGeneratable.ItemTypes({Image.class, Video.class}) 
public class MultiMediaGallery extends Content {

   private List<Slide> slides; 
   public List<Slide> getSlides() { return slides; }
   public void setSlides(List<Slide> slides) { this.slides = slides; }

   @Embedded
   private static abstract class Slide extends Record { } 

   private static class ImageSlide extends Slide { 
      private Image image;

      public Image getImage() {
         return image;
      }

      public void setImage(Image image) {
         this.image = image;
      }
   }

   private static class VideoSlide extends Slide { 
      private Video video;

      public Video getVideo() {
         return video;
      }

      public void setVideo(Video video) {
         this.video = video;
      }
   }

   public void fromSelection(SearchResultSelection selection) { 

      for (Object object : selection.createItemsQuery().selectAll()) {
         if (object instanceof Image) {
             // If the selected object is an Image, create a new ImageSlide to wrap it.
             ImageSlide imageSlide = new ImageSlide();
             imageSlide.setImage((Image) object);
             getSlides().add(imageSlide);

         } else if (object instanceof Video) {
             // If the selected object is a Video, create a new VideoSlide to wrap it.
             VideoSlide videoSlide = new VideoSlide();
             videoSlide.setVideo((Video) object);
             getSlides().add(videoSlide);
         }
         // Ignore any other objects that are not Images or Videos
      }
   }
}

• Class annotation that enables MultiMediaGallery objects to be created from Image and Video objects returned in search results.
• Defines a list for a Slide type and associated getter and setter methods.
• Embeds an abstract Slide class.
• Implements an ImageSlide inner class for slides consisting of Image objects.
• Implements a VideoSlide inner class for slides consisting of Video objects.
• Implements the fromSelection method from the SearchResultSelectionGeneratable interface. The method creates Image or Video slides from the SearchResultSelectionObject. After usage of the SearchResultSelection to create a new Content instance, the SearchResultSelection is destroyed.

public class MultiMediaGalleryAction implements SearchResultAction {

   @Override
   public int getPosition() {
      return 0;
   }

   @Override
   public boolean shouldDisplay(ToolPageContext page, Search search, SearchResultSelection selection) {
      return true;
   }

   // @Override
   public void writeHtml(
      ToolPageContext page,
      Search search,
      SearchResultSelection selection)
      throws IOException {

      if (selection == null) { 
         return;
      }

      page.writeStart("div", "class", "searchResult-action-simple");

      page.writeStart("a",
             "class", "button",
             "target", "toolUserMultiMedia",
             "href", new UrlBuilder(page.getRequest())  
                     .absolutePath(page.toolPath(CmsTool.class, "toolUserMultiMedia"))
                     .parameter("selectionId", selection.getId()));
      page.writeHtml(page.localize(MultiMediaGalleryAction.class, "action.MultiMediaGalleryAction"));
      page.writeEnd();
      page.writeEnd();
   }
}

• Checks for search results that are selected in the UI. If there are no selections, then the implementation does not display the action button.
• Constructs the URL to the page servlet, specified in the servlet routing path as tooUserMultiMedia. Only one parameter is passed to the servlet, selectionId, returned by the SearchResultSelection#getId() method.
• Specifies the label on the action button. The label is retrieved from a localization resource file.

@RoutingFilter.Path(application = "cms", value = "toolUserMultiMedia") public class ToolUserMultiMedia extends PageServlet {

   @Override
   protected String getPermissionId() {
      return null;
   }

   @Override
   protected void doService(ToolPageContext page) throws IOException, ServletException {

      UUID selectionId = page.param(UUID.class, "selectionId"); 
      SearchResultSelection selection = Query.from(SearchResultSelection.class).where("_id = ?", selectionId).first(); 

      MultiMediaGallery gallery = new MultiMediaGallery(); 
      gallery.fromSelection(selection);
      gallery.save();
   }
}

• Specifies the annotation @RoutingFilter.Path of the servlet as toolUserMultiMedia.
• Gets the value of the selectionId parameter passed from MultiMediaGalleryAction.
• Performs a query to get the SearchResultSelection object identified by selectionId.
• Creates a MultiMediaGallery object. The SearchResultSelection object can represent selections of various content types. However, MultiMediaGallery is limited to Image and Video item types, so the implemented fromSelection method creates gallery slides from only those types.

public class WriterContract extends Record {

   @Indexed
   private String name;

   @Indexed
   private String address;

   private StorageItem contract;

   // getters and setters
}

@Recordable.LabelFields({"name", "address"})
public class WriterContract extends Record {

   @Indexed
   private String name;

   @Indexed
   private String address;

   private StorageItem contract;

   // getters and setters
}