aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/ovsdb/rfc/src/main/java/org/onosproject/ovsdb/rfc/schema/DatabaseSchema.java
blob: 298afc682c205f25155b48db226cd5d61df9ffd8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/*
 * Copyright 2015 Open Networking Laboratory
 *
 * 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 org.onosproject.ovsdb.rfc.schema;

import static com.google.common.base.MoreObjects.toStringHelper;
import static com.google.common.base.Preconditions.checkNotNull;

import java.util.Map;
import java.util.Objects;
import java.util.Set;

/**
 * A schema for the database represented by database-schema, which consists of
 * a set of tables.
 */
public final class DatabaseSchema {

    private final String name;
    private final String version;
    private final Map<String, TableSchema> tableSchemas;

    /**
     * Constructs a DatabaseSchema object.
     * @param name the name of database
     * @param version the version of database
     * @param tableSchemas a map of TableSchema
     */
    public DatabaseSchema(String name, String version,
                          Map<String, TableSchema> tableSchemas) {
        checkNotNull(name, "name cannot be null");
        checkNotNull(version, "version cannot be null");
        checkNotNull(tableSchemas, "tableSchemas cannot be null");
        this.name = name;
        this.version = version;
        this.tableSchemas = tableSchemas;
    }

    /**
     * Returns the name of database.
     * @return the name of database
     */
    public String name() {
        return name;
    }

    /**
     * Returns the version of database.
     * @return the version of database
     */
    public String version() {
        return version;
    }

    /**
     * Returns a map of TableSchema.
     * @return a map of TableSchema
     */
    public Map<String, TableSchema> tableSchemas() {
        return tableSchemas;
    }

    /**
     * Returns a set of table name.
     * @return a set of table name
     */
    public Set<String> getTableNames() {
        return this.tableSchemas.keySet();
    }

    /**
     * Determine whether contain the table.
     * @param tableName table name
     * @return boolean
     */
    public boolean hasTable(String tableName) {
        return this.getTableNames().contains(tableName);
    }

    /**
     * Returns the TableSchema whose name is the tableName.
     * @param tableName table name
     * @return TableSchema
     */
    public TableSchema getTableSchema(String tableName) {
        TableSchema table = tableSchemas.get(tableName);
        return table;
    }

    /**
     * generate initialization columns in each table namely _uuid and _version.
     */
    public void generateInitializationColumns() {
        for (TableSchema tableSchema : tableSchemas.values()) {
            tableSchema.generateInitializationColumns();
        }
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, version, tableSchemas);
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj instanceof DatabaseSchema) {
            final DatabaseSchema other = (DatabaseSchema) obj;
            return Objects.equals(this.name, other.name)
                    && Objects.equals(this.version, other.version)
                    && Objects.equals(this.tableSchemas, other.tableSchemas);
        }
        return false;
    }

    @Override
    public String toString() {
        return toStringHelper(this).add("name", name).add("version", version)
                .add("tableSchemas", tableSchemas).toString();
    }
}