org.jpmml.rexp.RVector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pmml-rexp Show documentation
JPMML R to PMML converter
The newest version!
/*
 * Copyright (c) 2016 Villu Ruusmann
 *
 * This file is part of JPMML-R
 *
 * JPMML-R 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.
 *
 * JPMML-R 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 JPMML-R.  If not, see .
 */
package org.jpmml.rexp;

import java.util.Iterator;
import java.util.List;

import org.dmg.pmml.DataType;

abstract
public class RVector extends RExp implements Iterable {

	public RVector(RPair attributes){
		super(attributes);
	}

	abstract
	public DataType getDataType();

	abstract
	public int size();

	abstract
	public E getValue(int index);

	abstract
	public List getValues();

	@Override
	public Iterator iterator(){
		List values = getValues();

		return values.iterator();
	}

	public boolean isEmpty(){
		return (size() == 0);
	}

	public void checkSize(int size){
		List values = getValues();

		if(values.size() != size){
			throw new IllegalArgumentException("Expected " + size + " element(s), got " + values.size() + " element(s)");
		}
	}

	public void checkMinSize(int size){
		List values = getValues();

		if(values.size() < size){
			throw new IllegalArgumentException("Expected " + size + " or more element(s), got " + values.size() + " element(s)");
		}
	}

	public E asScalar(){
		List values = getValues();

		if(values.size() != 1){
			throw new IllegalStateException();
		}

		return values.get(0);
	}

	public int indexOf(E value){
		List values = getValues();

		return values.indexOf(value);
	}

	public E getElement(String name){
		return getElement(name, true);
	}

	public E getElement(String name, boolean required){
		return findElement(name, required);
	}

	public boolean hasElement(String name){

		if(isEmpty()){
			return false;
		}

		RStringVector names = names();

		List values = names.getDequotedValues();

		int index = values.indexOf(name);

		return (index > -1);
	}

	private E findElement(String name, boolean required){

		if(isEmpty()){
			return null;
		}

		RStringVector names = names();

		List values = names.getDequotedValues();

		int index = values.indexOf(name);
		if(index > -1){
			return getValue(index);
		} // End if

		if(required){
			throw new IllegalArgumentException("Missing \'" + name + "\' element");
		}

		return null;
	}

	@Override
	public String toString(){
		return String.valueOf(getValues());
	}
}