NodeCriteria.java

/**
 * OpenSpotLight - Open Source IT Governance Platform
 *
 * Copyright (c) 2009, CARAVELATECH CONSULTORIA E TECNOLOGIA EM INFORMATICA LTDA
 * or third-party contributors as indicated by the @author tags or express
 * copyright attribution statements applied by the authors.  All third-party
 * contributions are distributed under license by CARAVELATECH CONSULTORIA E
 * TECNOLOGIA EM INFORMATICA LTDA.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * See the GNU Lesser General Public License  for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 *
 ***********************************************************************
 * OpenSpotLight - Plataforma de Governança de TI de Código Aberto
 *
 * Direitos Autorais Reservados (c) 2009, CARAVELATECH CONSULTORIA E TECNOLOGIA
 * EM INFORMATICA LTDA ou como contribuidores terceiros indicados pela etiqueta
 * @author ou por expressa atribuição de direito autoral declarada e atribuída pelo autor.
 * Todas as contribuições de terceiros estão distribuídas sob licença da
 * CARAVELATECH CONSULTORIA E TECNOLOGIA EM INFORMATICA LTDA.
 *
 * Este programa é software livre; você pode redistribuí-lo e/ou modificá-lo sob os
 * termos da Licença Pública Geral Menor do GNU conforme publicada pela Free Software
 * Foundation.
 *
 * Este programa é distribuído na expectativa de que seja útil, porém, SEM NENHUMA
 * GARANTIA; nem mesmo a garantia implícita de COMERCIABILIDADE OU ADEQUAÇÃO A UMA
 * FINALIDADE ESPECÍFICA. Consulte a Licença Pública Geral Menor do GNU para mais detalhes.
 *
 * Você deve ter recebido uma cópia da Licença Pública Geral Menor do GNU junto com este
 * programa; se não, escreva para:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.openspotlight.storage;

import java.util.Set;

import org.openspotlight.storage.domain.StorageNode;
import org.openspotlight.storage.domain.key.NodeKey;
import org.openspotlight.storage.domain.key.NodeKey.CompositeKey;

public interface NodeCriteria {

    public interface NodeCriteriaBuilder {

        NodeCriteriaBuilder and();

        NodeCriteriaBuilder containsString(String value);

        NodeCriteriaBuilder endsWithString(String value);

        NodeCriteriaBuilder equalsTo(String value);

        NodeCriteriaBuilder startsWithString(String value);

        NodeCriteriaBuilder withLocalKey(CompositeKey localKey);

        NodeCriteriaBuilder withNodeType(String nodeName);

        NodeCriteriaBuilder withProperty(String propertyName);

        NodeCriteriaBuilder withUniqueKey(NodeKey uniqueKey);

        NodeCriteriaBuilder withUniqueKeyAsString(String uniqueKeyAsString);

        NodeCriteria buildCriteria();
    }

    public interface NodeCriteriaItem {

        public interface CompositeKeyCriteriaItem extends NodeCriteriaItem {
            CompositeKey getValue();
        }

        public interface NodeKeyAsStringCriteriaItem extends NodeCriteriaItem {
            String getKeyAsString();

        }

        public interface NodeKeyCriteriaItem extends NodeCriteriaItem {
            NodeKey getValue();

        }

        public interface PropertyContainsString extends NodeCriteriaItem {
            String getPropertyName();

            String getValue();
        }

        public interface PropertyCriteriaItem extends NodeCriteriaItem {

            String getPropertyName();

            String getValue();

        }

        public interface PropertyEndsWithString extends NodeCriteriaItem {
            String getPropertyName();

            String getValue();
        }

        public interface PropertyStartsWithString extends NodeCriteriaItem {
            String getPropertyName();

            String getValue();
        }

        String getNodeType();
    }

    Set<NodeCriteriaItem> getCriteriaItems();

    String getNodeType();

    Partition getPartition();

    Iterable<StorageNode> andSearch(StorageSession session);

    StorageNode andSearchUnique(StorageSession session);
}