net.solarnetwork.domain.datum.DatumStreamMetadata Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of net.solarnetwork.common Show documentation

Common supporting infrastructure for SolarNode and SolarNet applications.

There is a newer version: 3.27.0

Show newest version

/* ==================================================================
 * DatumStreamMetadata.java - 22/10/2020 3:01:10 pm
 * 
 * Copyright 2020 SolarNetwork.net Dev Team
 * 
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU  Public License as 
 * published by the Free Software Foundation; either version 2 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 
 *  Public License for more details.
 * 
 * You should have received a copy of the GNU  Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
 * 02111-1307 USA
 * ==================================================================
 */

package net.solarnetwork.domain.datum;

import java.util.UUID;

/**
 * Metadata about a datum stream.
 * 
 * @author matt
 * @version 2.1
 * @since 2.0
 */
public interface DatumStreamMetadata {

	/**
	 * Get the stream ID.
	 * 
	 * @return the stream ID
	 */
	UUID getStreamId();

	/**
	 * Get the time zone ID associated with this stream.
	 * 
	 * @return the time zone ID, or {@literal null} if not known
	 */
	String getTimeZoneId();

	/**
	 * Get all property names included in the stream.
	 * 
	 * @return the property names
	 */
	String[] getPropertyNames();

	/**
	 * Get the subset of all property names that are of a specific type.
	 * 
	 * @param type
	 *        the type of property to get the names for
	 * @return the property names, or {@literal null} if none available or
	 *         {@code type} is {@link DatumSamplesType#Tag}
	 */
	String[] propertyNamesForType(DatumSamplesType type);

	/**
	 * Get the index of a specific property name.
	 * 
	 * @param type
	 *        the type of property to get the index for
	 * @param name
	 *        the property name to search for
	 * @return the index, or {@literal -1} if not available
	 * @since 2.1
	 */
	default int propertyIndex(DatumSamplesType type, String name) {
		String[] names = propertyNamesForType(type);
		if ( names != null ) {
			for ( int i = 0, len = names.length; i < len; i++ ) {
				if ( name.equals(names[i]) ) {
					return i;
				}
			}
		}
		return -1;
	}

}