org.phenotips.messaging.DocumentReferenceType.java Source code

Introduction

Here is the source code for org.phenotips.messaging.DocumentReferenceType.java

Source

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see http://www.gnu.org/licenses/
 */
package org.phenotips.messaging;

import org.phenotips.components.ComponentManagerRegistry;

import org.xwiki.component.manager.ComponentLookupException;
import org.xwiki.model.reference.DocumentReference;
import org.xwiki.model.reference.DocumentReferenceResolver;

import java.io.Serializable;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Types;

import org.apache.commons.lang3.StringUtils;
import org.hibernate.HibernateException;
import org.hibernate.usertype.UserType;

/**
 * Custom Hibernate type used for storing document references in a database.
 *
 * @version $Id: 615afec73300488429bb4c2d7b2be69bbfb338df $
 * @since 1.0M1
 */
public class DocumentReferenceType implements UserType {
    @Override
    public int[] sqlTypes() {
        return new int[] { Types.VARCHAR };
    }

    @Override
    public Class<?> returnedClass() {
        return DocumentReference.class;
    }

    @Override
    public boolean equals(Object x, Object y) throws HibernateException {
        if (DocumentReference.class.isInstance(x) && DocumentReference.class.isInstance(y)) {
            return x.equals(y);
        }
        return false;
    }

    @Override
    public int hashCode(Object x) throws HibernateException {
        if (DocumentReference.class.isInstance(x)) {
            DocumentReference reference = (DocumentReference) x;
            return reference.hashCode();
        }
        return 0;
    }

    @Override
    public Object nullSafeGet(ResultSet rs, String[] names, Object owner) throws HibernateException, SQLException {
        String serializedReference = rs.getString(names[0]);
        return resolve(serializedReference);
    }

    @Override
    public void nullSafeSet(PreparedStatement st, Object value, int index) throws HibernateException, SQLException {
        if (DocumentReference.class.isInstance(value)) {
            st.setString(index, value.toString());
        } else {
            st.setNull(index, Types.VARCHAR);
        }
    }

    @Override
    public Object deepCopy(Object value) throws HibernateException {
        return value;
    }

    @Override
    public boolean isMutable() {
        return false;
    }

    @Override
    public Serializable disassemble(Object value) throws HibernateException {
        return String.valueOf(value);
    }

    @Override
    public Object assemble(Serializable cached, Object owner) throws HibernateException {
        if (String.class.isInstance(cached)) {
            return resolve((String) cached);
        }
        return null;
    }

    @Override
    public Object replace(Object original, Object target, Object owner) throws HibernateException {
        return original;
    }

    private DocumentReference resolve(String serializedReference) {
        if (StringUtils.isNotEmpty(serializedReference)) {
            try {
                DocumentReferenceResolver<String> resolver = ComponentManagerRegistry.getContextComponentManager()
                        .getInstance(DocumentReferenceResolver.TYPE_STRING);
                return resolver.resolve(serializedReference);
            } catch (ComponentLookupException ex) {
                // This really shouldn't happen...
            }
        }
        return null;
    }
}