/*
 * #!
 * Ontopia Engine
 * #-
 * Copyright (C) 2001 - 2013 The Ontopia Project
 * #-
 * 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 net.ontopia.topicmaps.utils;

import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import junit.framework.TestCase;
import net.ontopia.topicmaps.core.TopicIF;
import net.ontopia.topicmaps.core.TopicMapBuilderIF;
import net.ontopia.topicmaps.core.TopicMapIF;
import net.ontopia.topicmaps.core.TopicNameIF;
import net.ontopia.topicmaps.core.VariantNameIF;
import net.ontopia.utils.StringifierIF;
import net.ontopia.topicmaps.impl.basic.InMemoryTopicMapStore;

public class TopicStringifiersTest extends TestCase {

  protected TopicMapIF        topicmap; 
  protected TopicIF           topic; 
  protected TopicMapBuilderIF builder;
  protected Collection        empty;

  public TopicStringifiersTest(String name) {
    super(name);
  }
    
  public void setUp() {
    topicmap = makeTopicMap();
    topic = builder.makeTopic();
    empty = Collections.EMPTY_SET;
  }
    
  protected TopicMapIF makeTopicMap() {
    InMemoryTopicMapStore store = new InMemoryTopicMapStore();
    builder = store.getTopicMap().getBuilder();
    return store.getTopicMap();
  }
 
  // --- Test cases

  // getTopicNameStringifier

  public void testBNSEmpty() {
    StringifierIF sf = TopicStringifiers.getTopicNameStringifier(empty);
    assertTrue("Stringifying topic with no names did not give \"[No name]\"",
           sf.toString(topic).equals("[No name]"));
  }
        
  public void testBNSSingle() {
    StringifierIF sf = TopicStringifiers.getTopicNameStringifier(empty);
    builder.makeTopicName(topic, "Name");
                
    assertTrue("Stringifying topic with one name did not give that name",
           sf.toString(topic).equals("Name"));
  }

  public void testBNSDouble1() {
    TopicIF theme = builder.makeTopic();

    TopicNameIF bn1 = builder.makeTopicName(topic, "Name1");
    TopicNameIF bn2 = builder.makeTopicName(topic, "Name2");
    bn2.addTheme(theme);

    Set scope = new HashSet();
    scope.add(theme);
    StringifierIF sf = TopicStringifiers.getTopicNameStringifier(scope);
                
    assertTrue("Stringifying topic gave wrong name",
           sf.toString(topic).equals("Name2"));
  }

  public void testBNSDouble2() {
    TopicIF theme = builder.makeTopic();

    TopicNameIF bn1 = builder.makeTopicName(topic, "Name1");
    TopicNameIF bn2 = builder.makeTopicName(topic, "Name2");
    bn2.addTheme(theme);

    StringifierIF sf = TopicStringifiers.getTopicNameStringifier(empty);
                
    assertTrue("Stringifying topic gave wrong name",
           sf.toString(topic).equals("Name1"));
  }

  // getDefaultStringifier

  public void testDSEmpty() {
    StringifierIF sf = TopicStringifiers.getDefaultStringifier();
    assertTrue("Stringifying topic with no names did not give \"[No name]\"",
           sf.toString(topic).equals("[No name]"));
  }
        
  public void testDSSingle() {
    StringifierIF sf = TopicStringifiers.getDefaultStringifier();
    builder.makeTopicName(topic, "Name");
                
    assertTrue("Stringifying topic with one name did not give that name",
           sf.toString(topic).equals("Name"));
  }

  public void testDSComplex() {
    TopicIF theme = builder.makeTopic();

    TopicNameIF bn1 = builder.makeTopicName(topic, "Name1");
    TopicNameIF bn2 = builder.makeTopicName(topic, "Name2");
    bn2.addTheme(theme);

    StringifierIF sf = TopicStringifiers.getDefaultStringifier();
                
    assertTrue("Stringifying topic gave wrong name",
           sf.toString(topic).equals("Name1"));
  }

  public void testDSDisplay() {
    TopicIF display = builder.makeTopic();
    display.addSubjectIdentifier(PSI.getXTMDisplay());

    TopicNameIF bn1 = builder.makeTopicName(topic, "Name1");
    VariantNameIF vn1 = builder.makeVariantName(bn1, "Display name");
    vn1.addTheme(display);
    TopicNameIF bn2 = builder.makeTopicName(topic, "Name2");
    TopicNameIF bn3 = builder.makeTopicName(topic, "Name3");
    VariantNameIF vn2 = builder.makeVariantName(bn1, "Blecch");

    StringifierIF sf = TopicStringifiers.getDefaultStringifier();
    assertTrue("Stringifying topic gave wrong display name",
           sf.toString(topic).equals("Display name"));
  }

  public void testDSNull() {
    StringifierIF sf = TopicStringifiers.getDefaultStringifier();

    String result = sf.toString(null);
    String wanted = "[No name]";
    
    assertTrue("Stringifying null gave '" + result + "' instead of '" +
               wanted + "'", wanted.equals(sf.toString(null)));
  }
  
  // getSortNameStringifier

  public void testSSEmpty() {
    StringifierIF sf = TopicStringifiers.getSortNameStringifier();
    assertTrue("Stringifying topic with no names did not give \"[No name]\"",
           sf.toString(topic).equals("[No name]"));
  }
        
  public void testSSSingle() {
    StringifierIF sf = TopicStringifiers.getSortNameStringifier();
    builder.makeTopicName(topic, "Name");
                
    assertTrue("Stringifying topic with one name did not give that name",
           sf.toString(topic).equals("Name"));
  }

  public void testSSComplex() {
    TopicIF theme = builder.makeTopic();

    TopicNameIF bn1 = builder.makeTopicName(topic, "Name1");
    TopicNameIF bn2 = builder.makeTopicName(topic, "Name2");
    bn2.addTheme(theme);

    StringifierIF sf = TopicStringifiers.getSortNameStringifier();
                
    assertTrue("Stringifying topic gave wrong name",
           sf.toString(topic).equals("Name1"));
  }

  public void testSSSort() {
    TopicIF sort = builder.makeTopic();
    sort.addSubjectIdentifier(PSI.getXTMSort());

    TopicNameIF bn1 = builder.makeTopicName(topic, "Name1");
    VariantNameIF vn1 = builder.makeVariantName(bn1, "Sort name");
    vn1.addTheme(sort);
    TopicNameIF bn2 = builder.makeTopicName(topic, "Name2");
    TopicNameIF bn3 = builder.makeTopicName(topic, "Name3");
    VariantNameIF vn2 = builder.makeVariantName(bn1, "Blecch");

    StringifierIF sf = TopicStringifiers.getSortNameStringifier();
    assertTrue("Stringifying topic gave wrong sort name",
           sf.toString(topic).equals("Sort name"));
  }

  public void testVariantName() {
    TopicIF sort = builder.makeTopic();
    sort.addSubjectIdentifier(PSI.getXTMSort());

    TopicNameIF bn1 = builder.makeTopicName(topic, "Name1");
    VariantNameIF vn1 = builder.makeVariantName(bn1, "Sort name");
    vn1.addTheme(sort);
    TopicNameIF bn2 = builder.makeTopicName(topic, "Name2");
    TopicNameIF bn3 = builder.makeTopicName(topic, "Name3");
    VariantNameIF vn2 = builder.makeVariantName(bn1, "Blecch");

    StringifierIF sf =
      TopicStringifiers.getVariantNameStringifier(Collections.singleton(sort));
    assertTrue("Stringifying topic gave wrong variant name",
           sf.toString(topic).equals("Sort name"));
  }
}