All Downloads are FREE. Search and download functionalities are using the official Maven repository.

annis.visualizers.component.kwic.KWICVisualizer Maven / Gradle / Ivy

There is a newer version: 4.0.0-beta.4
Show newest version
/*
 * Copyright 2014 SFB 632.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package annis.visualizers.component.kwic;

import annis.libgui.VisualizationToggle;
import annis.libgui.media.MediaController;
import annis.libgui.media.PDFController;
import annis.libgui.visualizers.AbstractVisualizer;
import annis.libgui.visualizers.VisualizerInput;
import com.vaadin.server.VaadinSession;
import java.util.List;
import java.util.Map;
import java.util.Set;
import net.xeoh.plugins.base.annotations.PluginImplementation;
import org.corpus_tools.salt.common.STextualDS;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Key words in context visualizer (KWIC).
 * 
 * This visualizer has the same mappings as the {@link annis.visualizers.component.grid.GridVisualizer}.
 *
 * @author Thomas Krause 
 * @author Benjamin Weißenfels 
 */
@PluginImplementation
public class KWICVisualizer extends AbstractVisualizer
{
  private static final Logger log = LoggerFactory.getLogger(KWICVisualizer.class);
  
  @Override
  public String getShortName()
  {
    return "kwic";
  }

  @Override
  public KWICInterface createComponent(
    VisualizerInput visInput, VisualizationToggle visToggle)
  {
    MediaController mediaController = VaadinSession.getCurrent().getAttribute(
      MediaController.class);
    PDFController pdfController = VaadinSession.getCurrent().getAttribute(
      PDFController.class);
    
    List texts = visInput.getDocument().getDocumentGraph().
      getTextualDSs();

    // having the KWIC nested in a panel can slow down rendering
    if (texts.size() == 1)
    {
      // directly return the single non-nested KWIC panel
      return new KWICComponent(visInput,
        mediaController, pdfController, texts.get(0));
    }
    else
    {
      // return a more complicated implementation which can handle several texts
      return new KWICMultipleTextComponent(visInput, mediaController,
        pdfController);
    }
  }

  @Override
  public void setVisibleTokenAnnosVisible(KWICInterface component,
    Set annos)
  {
    component.setVisibleTokenAnnos(annos);
  }

  
  @Override
  public void setSegmentationLayer(KWICInterface visualizerImplementation,
    String segmentationName, Map markedAndCovered)
  {
    visualizerImplementation.setSegmentationLayer(segmentationName,
      markedAndCovered);
  }
  
  
  
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy