org.sonar.server.component.db.ComponentDao.java Source code

Java tutorial

Introduction

Here is the source code for org.sonar.server.component.db.ComponentDao.java

Source

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube 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 program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

package org.sonar.server.component.db;

import com.google.common.base.Function;
import com.google.common.collect.Lists;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.apache.ibatis.session.RowBounds;
import org.sonar.api.resources.Qualifiers;
import org.sonar.api.resources.Scopes;
import org.sonar.api.server.ServerSide;
import org.sonar.core.component.ComponentDto;
import org.sonar.core.component.FilePathWithHashDto;
import org.sonar.core.component.UuidWithProjectUuidDto;
import org.sonar.core.component.db.ComponentMapper;
import org.sonar.core.persistence.DaoComponent;
import org.sonar.core.persistence.DaoUtils;
import org.sonar.core.persistence.DbSession;
import org.sonar.server.es.SearchOptions;
import org.sonar.server.exceptions.NotFoundException;

import static com.google.common.collect.Maps.newHashMapWithExpectedSize;

/**
 * @since 4.3
 */
@ServerSide
public class ComponentDao implements DaoComponent {

    public ComponentDto selectById(Long id, DbSession session) {
        ComponentDto componentDto = selectNullableById(id, session);
        if (componentDto == null) {
            throw new NotFoundException(String.format("Project with id '%s' not found", id));
        }
        return componentDto;
    }

    @CheckForNull
    public ComponentDto selectNullableById(Long id, DbSession session) {
        return mapper(session).selectById(id);
    }

    @CheckForNull
    public ComponentDto selectNullableByUuid(DbSession session, String uuid) {
        return mapper(session).selectByUuid(uuid);
    }

    public ComponentDto selectByUuid(DbSession session, String uuid) {
        ComponentDto componentDto = selectNullableByUuid(session, uuid);
        if (componentDto == null) {
            throw new NotFoundException(String.format("Component with uuid '%s' not found", uuid));
        }
        return componentDto;
    }

    public boolean existsById(Long id, DbSession session) {
        return mapper(session).countById(id) > 0;
    }

    public List<ComponentDto> selectSubProjectsByComponentUuids(DbSession session, Collection<String> keys) {
        if (keys.isEmpty()) {
            return Collections.emptyList();
        }
        return mapper(session).selectSubProjectsByComponentUuids(keys);
    }

    public List<ComponentDto> selectDescendantModules(DbSession session, String rootComponentUuid) {
        return mapper(session).selectDescendantModules(rootComponentUuid, Scopes.PROJECT, false);
    }

    public List<ComponentDto> selectEnabledDescendantModules(DbSession session, String rootComponentUuid) {
        return mapper(session).selectDescendantModules(rootComponentUuid, Scopes.PROJECT, true);
    }

    public List<FilePathWithHashDto> selectEnabledDescendantFiles(DbSession session, String rootComponentUuid) {
        return mapper(session).selectDescendantFiles(rootComponentUuid, Scopes.FILE, true);
    }

    public List<FilePathWithHashDto> selectEnabledFilesFromProject(DbSession session, String rootComponentUuid) {
        return mapper(session).selectEnabledFilesFromProject(rootComponentUuid);
    }

    public List<ComponentDto> selectByIds(final DbSession session, Collection<Long> ids) {
        return DaoUtils.executeLargeInputs(ids, new Function<List<Long>, List<ComponentDto>>() {
            @Override
            public List<ComponentDto> apply(List<Long> partition) {
                return mapper(session).selectByIds(partition);
            }
        });
    }

    public List<ComponentDto> selectByUuids(final DbSession session, Collection<String> uuids) {
        return DaoUtils.executeLargeInputs(uuids, new Function<List<String>, List<ComponentDto>>() {
            @Override
            public List<ComponentDto> apply(List<String> partition) {
                return mapper(session).selectByUuids(partition);
            }
        });
    }

    public List<String> selectExistingUuids(final DbSession session, Collection<String> uuids) {
        return DaoUtils.executeLargeInputs(uuids, new Function<List<String>, List<String>>() {
            @Override
            public List<String> apply(List<String> partition) {
                return mapper(session).selectExistingUuids(partition);
            }
        });
    }

    public List<ComponentDto> selectComponentsFromProjectKey(DbSession session, String projectKey) {
        return mapper(session).selectComponentsFromProjectKeyAndScope(projectKey, null);
    }

    public List<ComponentDto> selectModulesFromProjectKey(DbSession session, String projectKey) {
        return mapper(session).selectComponentsFromProjectKeyAndScope(projectKey, Scopes.PROJECT);
    }

    public List<ComponentDto> selectByKeys(DbSession session, Collection<String> keys) {
        return mapper(session).selectByKeys(keys);
    }

    public ComponentDto selectByKey(DbSession session, String key) {
        ComponentDto value = selectNullableByKey(session, key);
        if (value == null) {
            throw new NotFoundException(String.format("Component key '%s' not found", key));
        }
        return mapper(session).selectByKey(key);
    }

    @CheckForNull
    public ComponentDto selectNullableByKey(DbSession session, String key) {
        return mapper(session).selectByKey(key);
    }

    public List<UuidWithProjectUuidDto> selectAllViewsAndSubViews(DbSession session) {
        return mapper(session).selectUuidsForQualifiers(Qualifiers.VIEW, Qualifiers.SUBVIEW);
    }

    public List<String> selectProjectsFromView(DbSession session, String viewUuid, String projectViewUuid) {
        return mapper(session).selectProjectsFromView("%." + viewUuid + ".%", projectViewUuid);
    }

    public List<ComponentDto> selectProvisionedProjects(DbSession session, SearchOptions searchOptions,
            @Nullable String query) {
        Map<String, String> parameters = newHashMapWithExpectedSize(2);
        addProjectQualifier(parameters);
        addPartialQueryParameterIfNotNull(parameters, query);

        return mapper(session).selectProvisionedProjects(parameters,
                new RowBounds(searchOptions.getOffset(), searchOptions.getLimit()));
    }

    public int countProvisionedProjects(DbSession session, @Nullable String query) {
        Map<String, String> parameters = newHashMapWithExpectedSize(2);
        addProjectQualifier(parameters);
        addPartialQueryParameterIfNotNull(parameters, query);

        return mapper(session).countProvisionedProjects(parameters);
    }

    public List<ComponentDto> selectGhostProjects(DbSession session, @Nullable String query,
            SearchOptions options) {
        Map<String, String> parameters = newHashMapWithExpectedSize(2);
        addProjectQualifier(parameters);
        addPartialQueryParameterIfNotNull(parameters, query);

        return mapper(session).selectGhostProjects(parameters,
                new RowBounds(options.getOffset(), options.getLimit()));
    }

    public long countGhostProjects(DbSession session, @Nullable String query) {
        Map<String, String> parameters = newHashMapWithExpectedSize(2);
        addProjectQualifier(parameters);
        addPartialQueryParameterIfNotNull(parameters, query);

        return mapper(session).countGhostProjects(parameters);
    }

    private static void addPartialQueryParameterIfNotNull(Map<String, String> parameters, @Nullable String query) {
        if (query != null) {
            parameters.put("query", "%" + query.toUpperCase() + "%");
        }
    }

    private static void addProjectQualifier(Map<String, String> parameters) {
        parameters.put("qualifier", Qualifiers.PROJECT);
    }

    public void insert(DbSession session, ComponentDto item) {
        mapper(session).insert(item);
    }

    public void insert(DbSession session, Collection<ComponentDto> items) {
        for (ComponentDto item : items) {
            insert(session, item);
        }
    }

    public void insert(DbSession session, ComponentDto item, ComponentDto... others) {
        insert(session, Lists.asList(item, others));
    }

    public void update(DbSession session, ComponentDto item) {
        mapper(session).update(item);
    }

    private ComponentMapper mapper(DbSession session) {
        return session.getMapper(ComponentMapper.class);
    }
}