com.vikingbrain.nmt.operations.playback.AbstractStartInsertOperation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of thedavidbox-client4j Show documentation

A Java HTTP client for consuming TheDavidBox Service API of Networked Media Tank devices

There is a newer version: 1.2.1

package com.vikingbrain.nmt.operations.playback;

import java.util.LinkedHashMap;

import com.vikingbrain.nmt.operations.AbstractTheDavidboxOperation;
import com.vikingbrain.nmt.operations.OperationType;
import com.vikingbrain.nmt.operations.TheDavidboxOperationFactory;
import com.vikingbrain.nmt.operations.parameters.DisplayMode;
import com.vikingbrain.nmt.responses.DavidBoxResponse;
import com.vikingbrain.nmt.util.UtilFile;

/**
 * Abstract class that represent a operation for start or insert operation in the playback module.
 * 
 * @author vikingBrain
 *
 * @param  the type of the response object for the operation
 */
public abstract class AbstractStartInsertOperation extends AbstractTheDavidboxOperation {

	/** Required operation attributes. */
	private String filePath;
	private DisplayMode displayMode;
	
	/**
	 * Constructor. Create the operation with the supplied parameters plus the default client parameters.
	 * @param operationFactory the operation factory
	 * @param operationType the operation type
	 * @param responseTargetClass the response target class
	 */
	protected AbstractStartInsertOperation(TheDavidboxOperationFactory operationFactory, OperationType operationType, 
			Class responseTargetClass, String filePath) {		
		super(operationFactory, operationType, responseTargetClass);
		
		this.filePath = filePath;
		//Default client attributes
		this.displayMode = operationFactory.getClientOptions().getDefaultDisplayMode();		
	}

	@Override
	/** {@inheritDoc} */
	public LinkedHashMap buildHttpArguments(){
		//Get http arguments from superclass
		LinkedHashMap httpArguments = super.buildHttpArguments();
		
		//file name
		httpArguments.put("arg1", UtilFile.getFileName(filePath));
		//file absolute uri file://opt/...
		httpArguments.put("arg2", UtilFile.getFileAbsoluteUri(filePath));   		

		return httpArguments;
	}	

	public final String getFilePath() {
		return filePath;
	}

	public final void setFilePath(String filePath) {
		this.filePath = filePath;
	}

	public final DisplayMode getDisplayMode() {
		return displayMode;
	}
	
	public final void setDisplayMode(DisplayMode displayMode) {
		this.displayMode = displayMode;
	}	

}