org.hibernate.metamodel.relational.Tuple Maven / Gradle / Ivy
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010 by Red Hat Inc and/or its affiliates or by
* third-party contributors as indicated by either @author tags or express
* copyright attribution statements applied by the authors. All
* third-party contributions are distributed under license by Red Hat Inc.
*
* 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
*/
package org.hibernate.metamodel.relational;
import java.util.LinkedHashSet;
/**
* Models a compound value (a tuple or row-value-constructor is SQL terms). It is both a {@link Value} and
* a {@link ValueContainer} simultaneously.
*
* IMPL NOTE : in terms of the tables themselves, SQL has no notion of a tuple/compound-value. We simply model
* it this way because:
*
* - it is a cleaner mapping to the logical model
* - it allows more meaningful traversals from simple values back up to table through any intermediate tuples
* because it gives us a better understanding of the model.
* - it better conveys intent
* - it adds richness to the model
*
*
* @author Steve Ebersole
*/
public class Tuple implements Value, ValueContainer, Loggable {
private final TableSpecification table;
private final String name;
private final LinkedHashSet values = new LinkedHashSet();
public Tuple(TableSpecification table, String name) {
this.table = table;
this.name = name;
}
@Override
public TableSpecification getTable() {
return table;
}
public int valuesSpan() {
return values.size();
}
@Override
public Iterable values() {
return values;
}
public void addValue(SimpleValue value) {
if ( ! value.getTable().equals( getTable() ) ) {
throw new IllegalArgumentException( "Tuple can only group values from same table" );
}
values.add( value );
}
@Override
public String getLoggableValueQualifier() {
return getTable().getLoggableValueQualifier() + '.' + name + "{tuple}";
}
@Override
public String toLoggableString() {
return getLoggableValueQualifier();
}
@Override
public void validateJdbcTypes(JdbcCodes typeCodes) {
for ( Value value : values() ) {
value.validateJdbcTypes( typeCodes );
}
}
}