Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-5662 - Import the initial work

This commit is contained in:
Steve Ebersole 2010-10-15 15:35:30 -05:00
parent 6ea31ce779
commit 40cd2bcd02
13 changed files with 618 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
hibernate-core/src/main/java/org/hibernate/metamodel/logical/AbstractAttributeContainer.java Normal file
View File

@ -0,0 +1,76 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat Inc. 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 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.logical;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.Set;
/**
* Convenient base class for {@link AttributeContainer}. Because in our model all
* {@link AttributeContainer AttributeContainers} are also {@link Hierarchical} we also implement that here
* as well.
*
* @author Steve Ebersole
*/
public abstract class AbstractAttributeContainer implements AttributeContainer, Hierarchical {
private final String name;
private final Hierarchical superType;
private LinkedHashSet<Attribute> attributeSet = new LinkedHashSet<Attribute>();
private HashMap<String,Attribute> attributeMap = new HashMap<String,Attribute>();
public AbstractAttributeContainer(String name, Hierarchical superType) {
this.name = name;
this.superType = superType;
}
@Override
public String getName() {
return name;
}
@Override
public Hierarchical getSuperType() {
return superType;
}
@Override
public Set<Attribute> getAttributes() {
return Collections.unmodifiableSet( attributeSet );
}
@Override
public Attribute getAttribute(String name) {
return attributeMap.get( name );
}
public void addAttribute(Attribute attribute) {
// todo : how to best "secure" this?
if ( attributeMap.put( attribute.getName(), attribute ) != null ) {
throw new IllegalArgumentException( "Attrtibute with name [" + attribute.getName() + "] already registered" );
}
attributeSet.add( attribute );
}
}

55
hibernate-core/src/main/java/org/hibernate/metamodel/logical/Attribute.java Normal file
View File

@ -0,0 +1,55 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat Inc. 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 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.logical;
/**
* Desribes an attribute.
*
* @author Steve Ebersole
*/
public interface Attribute {
/**
* Retrieve the attribute name.
*
* @return The attribute name.
*/
public String getName();
/**
* Retrieve the declaring container for this attribute (entity/component).
*
* @return The attribute container.
*/
public AttributeContainer getAttributeContainer();
/**
* An attribute can be either:<ul>
* <li>singular - castable to {@link SingularAttribute}</li>
* <li>plural - castable to {@link PluralAttribute}
* </ul>
*
* @return True if attribute is singular; false if plural.
*/
public boolean isSingular();
}

50
hibernate-core/src/main/java/org/hibernate/metamodel/logical/AttributeContainer.java Normal file
View File

@ -0,0 +1,50 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat Inc. 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 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.logical;
import java.util.Set;
/**
* Basic contract for any container holding attributes. This allows polymorphic handling of both
* components and entities in terms of the attributes they hold.
*
* @author Steve Ebersole
*/
public interface AttributeContainer extends Type {
/**
* Retrieve the attributes contained in this container.
*
* @return The contained attributes
*/
public Set<Attribute> getAttributes();
/**
* Retrieve an attribute by name.
*
* @param name The name of the attribute to retrieve.
*
* @return The attribute matching the given name, or null.
*/
public Attribute getAttribute(String name);
}

47
hibernate-core/src/main/java/org/hibernate/metamodel/logical/BasicType.java Normal file
View File

@ -0,0 +1,47 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat Inc. 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 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.logical;
/**
* Models a basic type, a simple value.
*
* @author Steve Ebersole
*/
public class BasicType implements Type {
private final String name;
public BasicType(String name) {
this.name = name;
}
@Override
public String getName() {
return name;
}
@Override
public TypeNature getNature() {
return TypeNature.BASIC;
}
}

42
hibernate-core/src/main/java/org/hibernate/metamodel/logical/Component.java Normal file
View File

@ -0,0 +1,42 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat Inc. 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 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.logical;
/**
* Models the notion of a component (what JPA calls an Embeddable).
* <p/>
* NOTE : Components are not currently really hierarchical. But that is a feature I want to add.
*
* @author Steve Ebersole
*/
public class Component extends AbstractAttributeContainer implements Hierarchical {
public Component(String name, Hierarchical superType) {
super( name, superType );
}
@Override
public TypeNature getNature() {
return TypeNature.COMPONENT;
}
}

42
hibernate-core/src/main/java/org/hibernate/metamodel/logical/Entity.java Normal file
View File

@ -0,0 +1,42 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat Inc. 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 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.logical;
/**
* Models the notion of an entity
*
* @author Steve Ebersole
*/
public class Entity extends AbstractAttributeContainer {
public Entity(String name, Hierarchical superType) {
super( name, superType );
}
/**
* {@inheritDoc}
*/
public TypeNature getNature() {
return TypeNature.ENTITY;
}
}

39
hibernate-core/src/main/java/org/hibernate/metamodel/logical/Hierarchical.java Normal file
View File

@ -0,0 +1,39 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat Inc. 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 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.logical;
/**
* Additional contract for things that can occur in an inheritance hierarchy (specifically ones we would
* need to traverse).
*
* @author Steve Ebersole
*/
public interface Hierarchical extends AttributeContainer {
/**
* Retrieve the super type.
*
* @return The super type, or null if no super type.
*/
public Hierarchical getSuperType();
}

57
hibernate-core/src/main/java/org/hibernate/metamodel/logical/PluralAttributeNature.java Normal file
View File

@ -0,0 +1,57 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat Inc. 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 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.logical;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Identifies the specific semantic of a plural valued attribute.
*
* @author Steve Ebersole
*/
public enum PluralAttributeNature {
BAG( "bag", Collection.class ),
SET( "set", Set.class ),
LIST( "list", List.class ),
MAP( "map", Map.class );
private final String name;
private final Class javaContract;
PluralAttributeNature(String name, Class javaContract) {
this.name = name;
this.javaContract = javaContract;
}
public String getName() {
return name;
}
public Class getJavaContract() {
return javaContract;
}
}

38
hibernate-core/src/main/java/org/hibernate/metamodel/logical/SingularAttribute.java Normal file
View File

@ -0,0 +1,38 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat Inc. 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 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.logical;
/**
* A single valued (non-collection) attribute
*
* @author Steve Ebersole
*/
public interface SingularAttribute extends Attribute {
/**
* Retrieve the attribute type descriptor.
*
* @return THe attribute type.
*/
public Type getSingularAttributeType();
}

42
hibernate-core/src/main/java/org/hibernate/metamodel/logical/Superclass.java Normal file
View File

@ -0,0 +1,42 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat Inc. 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 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.logical;
/**
* Models the concept of a (intermediate) superclass
*
* @author Steve Ebersole
*/
public class Superclass extends AbstractAttributeContainer implements Hierarchical {
public Superclass(String name, Hierarchical superType) {
super( name, superType );
}
/**
* {@inheritDoc}
*/
public TypeNature getNature() {
return TypeNature.SUPERCLASS;
}
}

46
hibernate-core/src/main/java/org/hibernate/metamodel/logical/Type.java Normal file
View File

@ -0,0 +1,46 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat Inc. 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 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.logical;
/**
* Basic information about a Java type, in regards to its role in particular set of mappings.
*
* @author Steve Ebersole
*/
public interface Type {
/**
* Get the name of the type.
*
* @return The name
*/
public String getName();
/**
* Return the persistence type.
*
* @return persistence type
*/
public TypeNature getNature();
}

50
hibernate-core/src/main/java/org/hibernate/metamodel/logical/TypeNature.java Normal file
View File

@ -0,0 +1,50 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat Inc. 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 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.logical;
/**
* Describes the type of a type :/
*
* @author Steve Ebersole
*/
public enum TypeNature {
BASIC( "basic" ),
COMPONENT( "component" ),
ENTITY( "entity" ),
SUPERCLASS( "superclass" );
private final String name;
private TypeNature(String name) {
this.name = name;
}
public String getName() {
return name;
}
public String toString() {
return super.toString() + "[" + getName() + "]";
}
}

34
hibernate-core/src/main/java/org/hibernate/metamodel/logical/package.html Normal file
View File

@ -0,0 +1,34 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ Copyright (c) 2010, Red Hat Inc. 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 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
-->
<html>
<body>
<p>
This package defines metadata modeling of a logical domain model. Specifically note that
this package does not in any way attempt to encapsulate data modeling information such
cardinality or associations. Also note that the top-level logical model is represetation (entity-mode)
agnostic.
</p>
</body>
</html>