org.jsynthlib.device.model

Class XMLPatchDriver

java.lang.Object

org.jsynthlib.device.model.AbstractDriver

org.jsynthlib.device.model.AbstractPatchDriver

org.jsynthlib.device.model.XMLPatchDriver

All Implemented Interfaces:

IDriver, IPatchDriver

Direct Known Subclasses:

D50SingleDriver, DX7FamilyXmlVoicePatchDriver, EmuProteus2SingleDriver, EnsoniqESQ1SingleDriver

public class XMLPatchDriver
extends AbstractPatchDriver
implements IPatchDriver

Author:

Pascal Collberg

Field Summary

Fields inherited from class org.jsynthlib.device.model.AbstractDriver

bankNumbers, checksumEnd, checksumOffset, checksumStart, deviceIDoffset, log, numSysexMsgs, patchNameSize, patchNameStart, patchNumbers, patchSize, sysexID, sysexRequestDump, trimSize

Constructor Summary

Constructors

Constructor and Description
XMLPatchDriver(XmlPatchDriverSpecDocument.XmlPatchDriverSpec driverSpec)

Method Summary

Modifier and Type	Method and Description
BankPatch	createNewBankPatch()
Patch	createNewPatch() Create a new Patch.
JSLFrame	editPatch(Patch patch) Override this if your driver implement Patch Editor.
byte[]	getInitPatch()
String	getPatchName(Patch p) Gets the name of the patch from the sysex.
String[]	getPatchNumbersForStore() Returns String[] list of patch numbers for writable patches.
boolean	hasEditor()
boolean	isConverter() Returns whether this driver is a Converter.
void	setDevice(Device d) Set Device with which this driver go.
void	setInitPatch(byte[] initPatch)
void	setPatchName(Patch patch, String s) Set the name of the patch in the sysex.
void	storePatch(Patch patch, int bankNum, int patchNum) Sends a patch to a set location on a synth.
String	toString() Returns full name for referring to this Driver.

Methods inherited from class org.jsynthlib.device.model.AbstractPatchDriver

getFullPatchName, isBankDriver, isSingleDriver

Methods inherited from class org.jsynthlib.device.model.AbstractDriver

calculateChecksum, calculateChecksum, calculateChecksum, canCreatePatch, createPatch, createPatch, createPatches, generateNumbers, getAuthors, getBankNumbers, getChannel, getChecksumEnd, getChecksumOffset, getChecksumStart, getDevice, getDeviceID, getDeviceIDoffset, getManufacturerName, getModelName, getPatchFactory, getPatchNameSize, getPatchNameStart, getPatchNumbers, getPatchSize, getPatchType, getSynthName, getSysexID, getSysexRequestDump, getTrimSize, playPatch, requestPatchDump, send, send, send, send, sendPatch, sendPatchWorker, setBankNum, setBankNumbers, setChecksumEnd, setChecksumOffset, setChecksumStart, setDeviceIDoffset, setPatchNameSize, setPatchNameStart, setPatchNum, setPatchNumbers, setPatchSize, setSysexID, setSysexRequestDump, setTrimSize, supportsPatch, trimSysex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jsynthlib.device.model.IDriver

calculateChecksum, calculateChecksum, canCreatePatch, createPatch, createPatch, createPatches, getAuthors, getBankNumbers, getChannel, getChecksumEnd, getChecksumOffset, getChecksumStart, getDevice, getDeviceID, getDeviceIDoffset, getPatchNameSize, getPatchNameStart, getPatchNumbers, getPatchSize, getPatchType, getSysexID, getSysexRequestDump, getTrimSize, isBankDriver, isSingleDriver, playPatch, requestPatchDump, send, sendPatch, setBankNumbers, setChecksumEnd, setChecksumOffset, setChecksumStart, setDeviceIDoffset, setPatchNameSize, setPatchNameStart, setPatchNumbers, setPatchSize, setSysexID, setSysexRequestDump, setTrimSize, supportsPatch, trimSysex

Constructor Detail

XMLPatchDriver

public XMLPatchDriver(XmlPatchDriverSpecDocument.XmlPatchDriverSpec driverSpec)

Method Detail

setDevice

public void setDevice(Device d)

Description copied from interface: IDriver

Set Device with which this driver go.

Specified by:

setDevice in interface IDriver

Overrides:

setDevice in class AbstractDriver

createNewPatch

public Patch createNewPatch()

Description copied from class: AbstractDriver

Create a new Patch. Don't override this unless your driver properly implement this method.

Overrides:

createNewPatch in class AbstractDriver

See Also:

IDriver.createPatch(), AbstractDriver.createPatch()

createNewBankPatch

public BankPatch createNewBankPatch()

isConverter

public boolean isConverter()

Description copied from interface: IDriver

Returns whether this driver is a Converter. Equivalent with instanceof IConverter. Note that there can be a Driver which are both Single Driver and Converter.

Specified by:

isConverter in interface IDriver

Overrides:

isConverter in class AbstractPatchDriver

See Also:

IConverter

getPatchName

public String getPatchName(Patch p)

Gets the name of the patch from the sysex. If the patch uses some weird format or encoding, this needs to be overidden in the particular driver.

Specified by:

getPatchName in interface IDriver

Overrides:

getPatchName in class AbstractPatchDriver

See Also:

Patch.getName()

setPatchName

public void setPatchName(Patch patch,
                         String s)

Description copied from class: AbstractPatchDriver

Set the name of the patch in the sysex. If the patch uses some weird format or encoding, this needs to be overidden in the particular driver.

Specified by:

setPatchName in interface IDriver

Overrides:

setPatchName in class AbstractPatchDriver

See Also:

Patch.setName(String)

hasEditor

public boolean hasEditor()

Specified by:

hasEditor in interface IDriver

Overrides:

hasEditor in class AbstractPatchDriver

See Also:

Patch.hasEditor()

editPatch

public JSLFrame editPatch(Patch patch)

Description copied from class: AbstractPatchDriver

Override this if your driver implement Patch Editor. Don't override this otherwise.

Specified by:

editPatch in interface IDriver

Overrides:

editPatch in class AbstractPatchDriver

See Also:

Patch.edit()

storePatch

public void storePatch(Patch patch,
                       int bankNum,
                       int patchNum)

Description copied from class: AbstractPatchDriver

Sends a patch to a set location on a synth.

Override this if required.

Specified by:

storePatch in interface IDriver

Overrides:

storePatch in class AbstractPatchDriver

See Also:

Patch.send(int, int)

getPatchNumbersForStore

public String[] getPatchNumbersForStore()

Description copied from interface: IPatchDriver

Returns String[] list of patch numbers for writable patches. This can be overridden if some patch locations are read only. e.g. the Waldorf Pulse has 100 patches, but only 0 to 39 are writable. Currently writable patches are assumed to start at patch location 0. (This has nothing to with the "Storable" class in JSynthLib.)

Specified by:

getPatchNumbersForStore in interface IPatchDriver

Overrides:

getPatchNumbersForStore in class AbstractPatchDriver

See Also:

DriverUtil#generateNumbers

getInitPatch

public byte[] getInitPatch()

setInitPatch

public void setInitPatch(byte[] initPatch)

toString

public String toString()

Description copied from interface: IDriver

Returns full name for referring to this Driver. Used for labels by driver selection comboboxes.

Specified by:

toString in interface IDriver

Overrides:

toString in class AbstractDriver