/*
* (c) Copyright 2006-2011 by Volker Bergmann. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, is permitted under the terms of the
* GNU General Public License.
*
* For redistributing this software or a derivative work under a license other
* than the GPL-compatible Free Software License as defined by the Free
* Software Foundation or approved by OSI, you must first obtain a commercial
* license to this software product from Volker Bergmann.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS,
* REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
* HEREBY EXCLUDED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package org.databene.benerator.wrapper;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.List;
import org.databene.benerator.Generator;
import org.databene.benerator.GeneratorContext;
import org.databene.benerator.InvalidGeneratorSetupException;
import org.databene.benerator.util.AbstractGenerator;
import org.databene.benerator.util.RandomUtil;
import org.databene.benerator.util.WrapperProvider;
import org.databene.commons.CollectionUtil;
import org.databene.commons.ProgrammerError;
/**
* Parent class for wrapping several other generators (in a <i>sources</i> property)
* and refining a composite state from them.<br/>
* <br/>
* Created: 19.12.2006 07:05:29
* @since 0.1
* @author Volker Bergmann
*/
public abstract class MultiGeneratorWrapper<S, P> extends AbstractGenerator<P> {
protected Class<P> generatedType;
protected List<Generator<? extends S>> sources;
private List<Generator<? extends S>> availableSources;
private WrapperProvider<S> sourceWrapperProvider;
public MultiGeneratorWrapper(Class<P> generatedType, Generator<? extends S>... sources) {
this(generatedType, CollectionUtil.toList(sources));
}
public MultiGeneratorWrapper(Class<P> generatedType, List<Generator<? extends S>> sources) {
this.generatedType = generatedType;
this.sources = new ArrayList<Generator<? extends S>>();
this.availableSources = new ArrayList<Generator<? extends S>>();
this.sourceWrapperProvider = new WrapperProvider<S>();
setSources(sources);
}
// properties ------------------------------------------------------------------------------------------------------
public List<Generator<? extends S>> getSources() {
return sources;
}
public synchronized void setSources(List<Generator<? extends S>> sources) {
this.sources.clear();
for (Generator<? extends S> source : sources)
addSource(source);
}
public Generator<? extends S> getSource(int index) {
return sources.get(index);
}
public synchronized void addSource(Generator<? extends S> source) {
sources.add(source);
}
protected int availableSourceCount() {
return availableSources.size();
}
protected Generator<? extends S> getAvailableSource(int index) {
return availableSources.get(index);
}
// Generator interface implementation ------------------------------------------------------------------------------
public Class<P> getGeneratedType() {
return generatedType;
}
@Override
public synchronized void init(GeneratorContext context) {
assertNotInitialized();
if (sources.size() == 0)
throw new InvalidGeneratorSetupException("sources", "is empty");
makeAllGeneratorsAvailable();
for (Generator<? extends S> source : sources) {
if (source != null) // some elements may be Mode.ignored
source.init(context);
}
super.init(context);
}
@Override
public synchronized void reset() {
for (Generator<? extends S> source : sources)
source.reset();
makeAllGeneratorsAvailable();
super.reset();
}
@Override
public synchronized void close() {
for (Generator<? extends S> source : sources)
source.close();
this.availableSources.clear();
super.close();
}
public boolean isThreadSafe() {
for (Generator<? extends S> source : sources)
if (!source.isThreadSafe())
return false;
return true;
}
public boolean isParallelizable() {
for (Generator<? extends S> source : sources)
if (!source.isParallelizable())
return false;
return true;
}
// helpers ---------------------------------------------------------------------------------------------------------
protected ProductWrapper<S> getSourceWrapper() {
return sourceWrapperProvider.get();
}
@SuppressWarnings({ "unchecked", "rawtypes" })
protected synchronized ProductWrapper<S> generateFromRandomSource(ProductWrapper<S> wrapper) {
assertInitialized();
if (availableSources.size() == 0)
return null;
ProductWrapper test;
do {
int sourceIndex = RandomUtil.randomIndex(availableSources);
test = availableSources.get(sourceIndex).generate((ProductWrapper) wrapper);
if (test == null)
availableSources.remove(sourceIndex);
} while (test == null && availableSources.size() > 0);
return test;
}
@SuppressWarnings({ "rawtypes", "unchecked" })
protected ProductWrapper<String> generateFromSource(int index, ProductWrapper<S> wrapper) {
assertInitialized();
if (index < 0 || index > sources.size())
throw new ProgrammerError("illegal generator index: " + index + " in " + this);
Generator<? extends S> source = sources.get(index);
ProductWrapper test = source.generate((ProductWrapper) wrapper);
if (test == null)
sources.remove(source);
return test;
}
@SuppressWarnings({ "rawtypes", "unchecked" })
protected ProductWrapper<S> generateFromAvailableSource(int i, ProductWrapper<S> wrapper) {
assertInitialized();
if (i < 0 || i >= availableSources.size())
return null;
ProductWrapper test;
do {
test = availableSources.get(i).generate((ProductWrapper) wrapper);
if (test == null)
availableSources.remove(i);
} while (test == null && i < availableSources.size());
return test;
}
@SuppressWarnings({ "unchecked", "rawtypes" })
protected synchronized S[] generateFromAllSources(Class<S> componentType) {
assertInitialized();
if (availableSources.size() < sources.size())
return null;
S[] result = (S[]) Array.newInstance(componentType, sources.size());
ProductWrapper elementWrapper = getSourceWrapper();
for (int i = 0; i < sources.size(); i++) {
elementWrapper = sources.get(i).generate(elementWrapper);
if (elementWrapper == null)
return null;
S product = (S) elementWrapper.unwrap();
result[i] = product;
}
return result;
}
private void makeAllGeneratorsAvailable() {
this.availableSources.clear();
for (Generator<? extends S> source : sources)
availableSources.add(source);
}
// java.lang.Object overrides --------------------------------------------------------------------------------------
@Override
public synchronized String toString() {
return getClass().getSimpleName() + sources;
}
}