/*
 * #!
 * 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.impl.rdbms.index;

import java.util.Collection;
import java.util.Collections;
import net.ontopia.persistence.proxy.QueryCollection;
import net.ontopia.topicmaps.core.AssociationIF;
import net.ontopia.topicmaps.core.AssociationRoleIF;
import net.ontopia.topicmaps.core.OccurrenceIF;
import net.ontopia.topicmaps.core.TopicIF;
import net.ontopia.topicmaps.core.TopicNameIF;
import net.ontopia.topicmaps.core.index.ClassInstanceIndexIF;
import net.ontopia.topicmaps.impl.utils.IndexManagerIF;
import net.ontopia.topicmaps.utils.PSI;

/**
 * INTERNAL: The rdbms class instance index implementation.
 */
public class ClassInstanceIndex extends RDBMSIndex
  implements ClassInstanceIndexIF {

  ClassInstanceIndex(IndexManagerIF imanager) {
    super(imanager);
  }

  // ---------------------------------------------------------------------------
  // ClassInstanceIndexIF
  // ---------------------------------------------------------------------------
  
  public Collection<TopicIF> getTopics(TopicIF topic_type) {
    if (topic_type == null) {
      Object[] params = new Object[] { getTopicMap() };
      return new QueryCollection<TopicIF>(transaction.getTransaction(),
                             "ClassInstanceIndexIF.getTopics_null_size", params,
                             "ClassInstanceIndexIF.getTopics_null", params);
    } else {
      Object[] params = new Object[] { topic_type };
      return new QueryCollection<TopicIF>(transaction.getTransaction(),
                                 "ClassInstanceIndexIF.getTopics_size", params,
                                 "ClassInstanceIndexIF.getTopics", params);
    }
  }
  
  public Collection<TopicNameIF> getTopicNames(TopicIF name_type) {
    if (name_type == null) {
      name_type = getTopicMap().getTopicBySubjectIdentifier(PSI.getSAMNameType());
      if (name_type == null) {
        return Collections.emptySet();
      }
      return getTopicNames(name_type);
    } else {
      Object[] params = new Object[] { getTopicMap(), name_type };
      return new QueryCollection<TopicNameIF>(transaction.getTransaction(), "ClassInstanceIndexIF.getTopicNames_size", params,
                                 "ClassInstanceIndexIF.getTopicNames", params);
    }
  }
  
  public Collection<OccurrenceIF> getOccurrences(TopicIF occurrence_type) {
    if (occurrence_type == null) {
      return Collections.emptySet();
    } else {
      Object[] params = new Object[] { getTopicMap(), occurrence_type };
      return new QueryCollection<OccurrenceIF>(transaction.getTransaction(), "ClassInstanceIndexIF.getOccurrences_size", params,
                                 "ClassInstanceIndexIF.getOccurrences", params);
    }
  }
  
  public Collection<AssociationIF> getAssociations(TopicIF association_type) {
    if (association_type == null) {
      return Collections.emptySet();
    } else {
      Object[] params = new Object[] { getTopicMap(), association_type };
      return new QueryCollection<AssociationIF>(transaction.getTransaction(), "ClassInstanceIndexIF.getAssociations_size", params,
                                 "ClassInstanceIndexIF.getAssociations", params);
    }
  }

  public Collection<AssociationRoleIF> getAssociationRoles(TopicIF association_role_type) {
    if (association_role_type == null) {
      return Collections.emptySet();
    } else {
      Object[] params = new Object[] { getTopicMap(), association_role_type };
      return new QueryCollection<AssociationRoleIF>(transaction.getTransaction(), "ClassInstanceIndexIF.getAssociationRoles_size", params,
                                 "ClassInstanceIndexIF.getAssociationRoles", params);
    }
  }

  public Collection<TopicIF> getTopicTypes() {
    return (Collection<TopicIF>)executeQuery("ClassInstanceIndexIF.getTopicTypes",
                                    new Object[] { getTopicMap() });
  }
  
  public Collection<TopicIF> getTopicNameTypes() {
    return (Collection<TopicIF>)executeQuery("ClassInstanceIndexIF.getTopicNameTypes",
                                    new Object[] { getTopicMap() });
  }
  
  public Collection<TopicIF> getOccurrenceTypes() {
    return (Collection<TopicIF>)executeQuery("ClassInstanceIndexIF.getOccurrenceTypes",
                                    new Object[] { getTopicMap() });
  }
  
  public Collection<TopicIF> getAssociationTypes() {
    return (Collection<TopicIF>)executeQuery("ClassInstanceIndexIF.getAssociationTypes",
                                    new Object[] { getTopicMap() });
  }
  
  public Collection<TopicIF> getAssociationRoleTypes() {
    return (Collection<TopicIF>)executeQuery("ClassInstanceIndexIF.getAssociationRoleTypes",
                                    new Object[] { getTopicMap() });
  }
  
  public boolean usedAsTopicType(TopicIF topic) {
    return !(getTopics(topic).isEmpty());    
  }

  public boolean usedAsTopicNameType(TopicIF topic) {
    return !(getTopicNames(topic).isEmpty());
  }

  public boolean usedAsOccurrenceType(TopicIF topic) {
    return !(getOccurrences(topic).isEmpty());
  }

  public boolean usedAsAssociationType(TopicIF topic) {
    return !(getAssociations(topic).isEmpty());
  }
  
  public boolean usedAsAssociationRoleType(TopicIF topic) {
    return !(getAssociationRoles(topic).isEmpty());
  }
  
  public boolean usedAsType(TopicIF topic) {
    if (topic == null) return false;
    return (usedAsTopicType(topic) ||
            usedAsAssociationType(topic) ||
            usedAsAssociationRoleType(topic) ||
            usedAsOccurrenceType(topic) ||
            usedAsTopicNameType(topic));
  }
}