net.sf.jasperreports.engine.virtualization.VirtualizationOutput Maven / Gradle / Ivy

/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2016 TIBCO Software Inc. All rights reserved.
 * http://www.jaspersoft.com
 *
 * Unless you have purchased a commercial license agreement from Jaspersoft,
 * the following license terms apply:
 *
 * This program is part of JasperReports.
 *
 * JasperReports is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JasperReports 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 JasperReports. If not, see .
 */
package net.sf.jasperreports.engine.virtualization;

import java.io.IOException;
import java.io.ObjectOutputStream;
import java.io.ObjectStreamClass;
import java.io.OutputStream;
import java.util.HashMap;
import java.util.IdentityHashMap;
import java.util.Map;

import net.sf.jasperreports.engine.JRRuntimeException;
import net.sf.jasperreports.engine.fill.JRVirtualizationContext;
import net.sf.jasperreports.engine.util.VirtualizationSerializer;

/**
 * @author Lucian Chirita ([email protected])
 */
public class VirtualizationOutput extends ObjectOutputStream
{
	public static final String EXCEPTION_MESSAGE_KEY_UNSUPPORTED_REFERENCE_TYPE = "engine.virtualization.output.unsupported.reference.type";
	
	private final VirtualizationSerializer virtualizationSerializer;
	private final JRVirtualizationContext virtualizationContext;
	
	private final SerializerRegistry serializerRegistry = DefaultSerializerRegistry.getInstance();
	
	@SuppressWarnings("unchecked")
	private final Map[] writtenObjects = new Map[SerializationConstants.OBJECT_TYPE_COUNT];

	public VirtualizationOutput(OutputStream out,
			VirtualizationSerializer serializer,
			JRVirtualizationContext virtualizationContext) throws IOException
	{
		super(out);
		
		this.virtualizationSerializer = serializer;
		this.virtualizationContext = virtualizationContext;
	}

	public JRVirtualizationContext getVirtualizationContext()
	{
		return virtualizationContext;
	}

	@Override
	protected void annotateClass(Class clazz) throws IOException
	{
		super.annotateClass(clazz);

		// TODO lucianc investigate if we still need this
		int loaderIdx = virtualizationSerializer.getClassloaderIdx(clazz);
		writeShort(loaderIdx);
	}

	@Override
	protected void writeClassDescriptor(ObjectStreamClass desc)
			throws IOException
	{
		Class clazz = desc.forClass();
		if (clazz == null)
		{
			throw new RuntimeException();
		}
		
		int classIdx = virtualizationSerializer.getClassDescriptorIdx(clazz);
		writeIntCompressed(classIdx);
	}
	
	public void writeIntCompressed(int value) throws IOException
	{
		SerializationUtils.writeIntCompressed(this, value);
	}
	
	// didn't find another name
	public void writeJRObject(Object o) throws IOException
	{
		writeJRObject(o, null, null);
	}
	
	@SuppressWarnings("unchecked")
	public void writeJRObject(Object o, Boolean lookupReference, Boolean storeReference) throws IOException
	{
		if (o == null)
		{
			writeByte(SerializationConstants.OBJECT_NULL);
			return;
		}
		
		@SuppressWarnings("rawtypes")
		ObjectSerializer serializer = serializerRegistry.getSerializer(o.getClass());
		if (serializer == null)
		{
			writeByte(SerializationConstants.OBJECT_ARBITRARY);
			writeObject(o);
			return;
		}
		
		int typeValue = serializer.typeValue();
		boolean typeStoreReference = serializer.defaultStoreReference();
		if (lookupReference == null ? typeStoreReference : lookupReference)
		{
			Integer objectIndex = findReference(typeValue, o);
			if (objectIndex != null)
			{
				writeByte(SerializationConstants.OBJECT_REF_MASK | typeValue);
				writeIntCompressed(objectIndex);
				return;
			}
		}
		
		if (storeReference == null ? typeStoreReference : storeReference)
		{
			ReferenceType referenceType = serializer.defaultReferenceType();
			putReference(typeValue, referenceType, o);
		}
		
		writeByte(typeValue);
		serializer.write(o, this);
	}
	
	protected Integer findReference(int typeValue, Object value)
	{
		Map objectsMap = writtenObjects[typeValue - SerializationConstants.OBJECT_TYPE_OFFSET];
		return objectsMap == null ? null : objectsMap.get(value);
	}
	
	protected void putReference(int typeValue, ReferenceType referenceType, Object value)
	{
		Map objectsMap = writtenObjects[typeValue - SerializationConstants.OBJECT_TYPE_OFFSET];
		if (objectsMap == null)
		{
			switch (referenceType)
			{
			case OBJECT:
				objectsMap = new HashMap();
				break;
			case IDENTITY:
				objectsMap = new IdentityHashMap();
				break;
			default:
				throw 
					new JRRuntimeException(
						EXCEPTION_MESSAGE_KEY_UNSUPPORTED_REFERENCE_TYPE,
						new Object[]{referenceType});
			}
			
			writtenObjects[typeValue - SerializationConstants.OBJECT_TYPE_OFFSET] = objectsMap;
		}
		
		int objectIndex = objectsMap.size();
		objectsMap.put(value, objectIndex);
	}
}