org.hibernate.collection.internal.PersistentIndexedElementHolder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-core
The core O/RM functionality as provided by Hibernate
There is a newer version: 7.0.0.Alpha1
/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2008-2011, 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.collection.internal;

import java.io.Serializable;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.hibernate.AssertionFailure;
import org.hibernate.HibernateException;
import org.hibernate.engine.spi.SessionFactoryImplementor;
import org.hibernate.engine.spi.SessionImplementor;
import org.hibernate.loader.CollectionAliases;
import org.hibernate.persister.collection.CollectionPersister;
import org.hibernate.type.Type;
import org.hibernate.type.XmlRepresentableType;

import org.dom4j.Element;

/**
 * A persistent wrapper for an XML element
 *
 * @author Gavin King
 *
 * @deprecated To be removed in 5.  Removed as part of removing the notion of DOM entity-mode.  See Jira issues
 * HHH-7782 and
 * HHH-7783 for more information.
 */
@Deprecated
public abstract class PersistentIndexedElementHolder extends AbstractPersistentCollection {
	protected Element element;

	/**
	 * Constructs a PersistentIndexedElementHolder.
	 *
	 * @param session The session
	 * @param element The DOM element being wrapped
	 */
	public PersistentIndexedElementHolder(SessionImplementor session, Element element) {
		super( session );
		this.element = element;
		setInitialized();
	}

	/**
	 * Constructs a PersistentIndexedElementHolder.
	 *
	 * @param session The session
	 * @param persister The collection persister
	 * @param key The collection key (fk value)@throws HibernateException
	 */
	public PersistentIndexedElementHolder(SessionImplementor session, CollectionPersister persister, Serializable key) {
		super( session );
		final Element owner = (Element) session.getPersistenceContext().getCollectionOwner( key, persister );
		if ( owner == null ) {
			throw new AssertionFailure( "null owner" );
		}

		final String nodeName = persister.getNodeName();
		if ( ".".equals( nodeName ) ) {
			element = owner;
		}
		else {
			element = owner.element( nodeName );
			if ( element == null ) {
				element = owner.addElement( nodeName );
			}
		}
	}

	/**
	 * A struct representing the index/value pair.
	 */
	public static final class IndexedValue {
		final String index;
		final Object value;

		IndexedValue(String index, Object value) {
			this.index = index;
			this.value = value;
		}
	}
	
	protected static String getIndex(Element element, String indexNodeName, int i) {
		if ( indexNodeName != null ) {
			return element.attributeValue( indexNodeName );
		}
		else {
			return Integer.toString( i );
		}
	}
	
	protected static void setIndex(Element element, String indexNodeName, String index) {
		if ( indexNodeName != null ) {
			element.addAttribute( indexNodeName, index );
		}
	}

	protected static String getIndexAttributeName(CollectionPersister persister) {
		final String node = persister.getIndexNodeName();
		return node == null ? null : node.substring( 1 );
	}

	@Override
	@SuppressWarnings({"unchecked", "deprecation"})
	public Serializable getSnapshot(CollectionPersister persister) throws HibernateException {
		final Type elementType = persister.getElementType();
		final String indexNode = getIndexAttributeName( persister );
		final List elements = element.elements( persister.getElementNodeName() );
		final HashMap snapshot = new HashMap( elements.size() );
		for ( int i=0; i