Package com.cosylab.vdct.vdb

Class VDBTemplate

java.lang.Object

com.cosylab.vdct.vdb.VDBTemplate

All Implemented Interfaces:

Descriptable, Inspectable, Commentable, MonitoredPropertyListener

public class VDBTemplate
extends Object
implements Inspectable, Commentable, Descriptable, MonitoredPropertyListener

Data object representing EPICS DB template. All data is obtained from DB file. Group contains template structure.

Author:

Matej

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description
protected String	fileName
protected Group	group
protected String	id
protected String	ioc
protected Hashtable	macros
protected Vector	macrosV
protected long	modificationTime
protected Hashtable	ports
protected Vector	portsV
protected static Random	random
protected String	version

Constructor Summary

Constructors

Constructor	Description
VDBTemplate(String id, String fileName)	Constructor for VDBTemplate.

Method Summary

Modifier and Type	Method	Description
VDBMacro	addMacro()
void	addMacro(VDBMacro vdbMacro)
VDBMacro	addMacro(String name)
VDBPort	addPort()
void	addPort(VDBPort vdbPort)
VDBPort	addPort(String name)
void	addProperty()
String	getComment()	Returns the comment.
InspectableProperty	getCommentProperty()
String	getDescription()	Returns the description.
Object	getDsId()
String	getFileName()	Returns the fileName.
Group	getGroup()	Returns the group.
Icon	getIcon()	Insert the method's description here.
String	getId()	Returns the id.
String	getIoc()
Hashtable	getMacros()	Returns the macros.
long	getMacrosGeneratedID()	Returns the macrosGeneratedID.
static GUISeparator	getMacrosSeparator()	Insert the method's description here.
Vector	getMacrosV()	Returns the macrosV.
ArrayList	getModeNames()	Obtains list of all mode names for this particular property.
long	getModificationTime()
String	getName()	Insert the method's description here.
Hashtable	getPorts()	Returns the ports.
long	getPortsGeneratedID()	Returns the portsGeneratedID.
static GUISeparator	getPortsSeparator()	Insert the method's description here.
Vector	getPortsV()	Returns the portsV.
InspectableProperty[]	getProperties(int mode, boolean spreadsheet)
String	getRealDescription()	Returns the description.
static GUISeparator	getTemplateSeparator()	Insert the method's description here.
String	getVersion()
void	propertyChanged(InspectableProperty property)
void	removeMacro(VDBMacro macro)
void	removeMacro(String name)
void	removePort(VDBPort port)
void	removePort(String name)
void	removeProperty(InspectableProperty property)
void	renameMacro(VDBMacro macro, String newName)
void	renameMacroProperty(InspectableProperty property)
void	renamePort(VDBPort port, String newName)
void	renamePortProperty(InspectableProperty property)
void	renameProperty(InspectableProperty property)
void	setComment(String comment)	Sets the comment.
void	setDescription(String description)	Sets the description.
void	setFileName(String fileName)	Sets the fileName.
void	setGroup(Group group)	Sets the group.
void	setId(Object dsId, String id)	Sets the id.
void	setIoc(String ioc)
void	setMacros(Hashtable macros)	Sets the macros.
void	setMacrosV(Vector macrosV)	Sets the macrosV.
void	setModificationTime(long modificationTime)
void	setPorts(Hashtable ports)	Sets the ports.
void	setPortsV(Vector portsV)	Sets the portsV.
void	setVersion(String version)
String	toString()	Insert the method's description here.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected String id

fileName

protected String fileName

description

protected String description

modificationTime

protected long modificationTime

version

protected String version

ioc

protected String ioc

ports

protected Hashtable ports

portsV

protected Vector portsV

macros

protected Hashtable macros

macrosV

protected Vector macrosV

group

protected Group group

random

protected static Random random

Constructor Detail

VDBTemplate

public VDBTemplate(String id,
                   String fileName)

Constructor for VDBTemplate.

Parameters:

id - id

fileName - fileName

Method Detail

getDescription

public String getDescription()

Returns the description.

Specified by:

getDescription in interface Descriptable

Returns:

String

getRealDescription

public String getRealDescription()

Returns the description.

Returns:

String

getGroup

public Group getGroup()

Returns the group.

Returns:

Group

setDescription

public void setDescription(String description)

Sets the description.

Specified by:

setDescription in interface Descriptable

Parameters:

description - The description to set

setGroup

public void setGroup(Group group)

Sets the group.

Parameters:

group - The group to set

getFileName

public String getFileName()

Returns the fileName.

Returns:

String

getId

public String getId()

Returns the id.

Returns:

String

getModificationTime

public long getModificationTime()

Returns:

the modificationTime

setModificationTime

public void setModificationTime(long modificationTime)

Parameters:

modificationTime - the modificationTime to set

getCommentProperty

public InspectableProperty getCommentProperty()

Specified by:

getCommentProperty in interface Inspectable

Returns:

com.cosylab.vdct.inspector.InspectableProperty

See Also:

Inspectable.getCommentProperty()

getIcon

public Icon getIcon()

Description copied from interface: Inspectable

Insert the method's description here. Creation date: (10.1.2001 15:14:56)

Specified by:

getIcon in interface Inspectable

Returns:

javax.swing.Icon

See Also:

Inspectable.getIcon()

getModeNames

public ArrayList getModeNames()

Description copied from interface: Inspectable

Obtains list of all mode names for this particular property. Modes are numbered from 0-n. Creation date: (11.1.2001 21:30:04)

Specified by:

getModeNames in interface Inspectable

Returns:

java.util.ArrayList array of mode names - obtained using toString().

See Also:

Inspectable.getModeNames()

getName

public String getName()

Description copied from interface: Inspectable

Insert the method's description here. Creation date: (10.1.2001 14:47:43)

Specified by:

getName in interface Commentable

Specified by:

getName in interface Inspectable

Returns:

java.lang.String

See Also:

Inspectable.getName()

getTemplateSeparator

public static GUISeparator getTemplateSeparator()

Insert the method's description here. Creation date: (3.2.2001 13:07:04)

Returns:

com.cosylab.vdct.vdb.GUISeparator

getProperties

public InspectableProperty[] getProperties(int mode,
                                           boolean spreadsheet)

Specified by:

getProperties in interface Inspectable

Parameters:

mode - mode

spreadsheet - spreadsheet

Returns:

com.cosylab.vdct.inspector.InspectableProperty[]

See Also:

Inspectable.getProperties(int, boolean spreadsheet)

toString

public String toString()

Insert the method's description here. Creation date: (10.1.2001 14:49:50)

Specified by:

toString in interface Inspectable

Overrides:

toString in class Object

Returns:

java.lang.String

getComment

public String getComment()

Returns the comment.

Specified by:

getComment in interface Commentable

Returns:

String

setComment

public void setComment(String comment)

Sets the comment.

Specified by:

setComment in interface Commentable

Parameters:

comment - The comment to set

getPorts

public Hashtable getPorts()

Returns the ports.

Returns:

Hashtable

getPortsV

public Vector getPortsV()

Returns the portsV.

Returns:

Vector

getMacros

public Hashtable getMacros()

Returns the macros.

Returns:

Hashtable

getMacrosV

public Vector getMacrosV()

Returns the macrosV.

Returns:

Vector

setPorts

public void setPorts(Hashtable ports)

Sets the ports.

Parameters:

ports - The ports to set

setPortsV

public void setPortsV(Vector portsV)

Sets the portsV.

Parameters:

portsV - The portsV to set

setMacros

public void setMacros(Hashtable macros)

Sets the macros.

Parameters:

macros - The macros to set

setMacrosV

public void setMacrosV(Vector macrosV)

Sets the macrosV.

Parameters:

macrosV - The macrosV to set

getPortsSeparator

public static GUISeparator getPortsSeparator()

Insert the method's description here. Creation date: (3.2.2001 13:07:04)

Returns:

com.cosylab.vdct.vdb.GUISeparator

getMacrosSeparator

public static GUISeparator getMacrosSeparator()

Insert the method's description here. Creation date: (3.2.2001 13:07:04)

Returns:

com.cosylab.vdct.vdb.GUISeparator

addPort

public VDBPort addPort(String name)

Parameters:

name - name

Returns:

something

addMacro

public VDBMacro addMacro(String name)

Parameters:

name - name

Returns:

something

addPort

public void addPort(VDBPort vdbPort)

Parameters:

vdbPort - vdbPort

addMacro

public void addMacro(VDBMacro vdbMacro)

Parameters:

vdbMacro - vdbMacro

removePort

public void removePort(String name)

Parameters:

name - name

removeMacro

public void removeMacro(String name)

Parameters:

name - name

removePort

public void removePort(VDBPort port)

Parameters:

port - port

removeMacro

public void removeMacro(VDBMacro macro)

Parameters:

macro - macro

renamePort

public void renamePort(VDBPort port,
                       String newName)

Parameters:

port - port

newName - newName

renameMacro

public void renameMacro(VDBMacro macro,
                        String newName)

Parameters:

macro - macro

newName - newName

addProperty

public void addProperty()

Specified by:

addProperty in interface MonitoredPropertyListener

See Also:

MonitoredPropertyListener.addProperty()

addPort

public VDBPort addPort()

Returns:

something

addMacro

public VDBMacro addMacro()

Returns:

something

propertyChanged

public void propertyChanged(InspectableProperty property)

Specified by:

propertyChanged in interface MonitoredPropertyListener

Parameters:

property - property

See Also:

MonitoredPropertyListener.propertyChanged(InspectableProperty)

removeProperty

public void removeProperty(InspectableProperty property)

Specified by:

removeProperty in interface MonitoredPropertyListener

Parameters:

property - property

See Also:

MonitoredPropertyListener.removeProperty(InspectableProperty)

renameProperty

public void renameProperty(InspectableProperty property)

Specified by:

renameProperty in interface MonitoredPropertyListener

Parameters:

property - property

See Also:

MonitoredPropertyListener.renameProperty(InspectableProperty)

renamePortProperty

public void renamePortProperty(InspectableProperty property)

Parameters:

property - property

See Also:

MonitoredPropertyListener.renameProperty(InspectableProperty)

renameMacroProperty

public void renameMacroProperty(InspectableProperty property)

Parameters:

property - property

See Also:

MonitoredPropertyListener.renameProperty(InspectableProperty)

setFileName

public void setFileName(String fileName)

Sets the fileName.

Parameters:

fileName - The fileName to set

setId

public void setId(Object dsId,
                  String id)

Sets the id.

Parameters:

dsId - dsId

id - The id to set

getPortsGeneratedID

public long getPortsGeneratedID()

Returns the portsGeneratedID.

Returns:

long

getMacrosGeneratedID

public long getMacrosGeneratedID()

Returns the macrosGeneratedID.

Returns:

long

getVersion

public String getVersion()

Returns:

something

setVersion

public void setVersion(String version)

Parameters:

version - version

getIoc

public String getIoc()

Returns:

something

setIoc

public void setIoc(String ioc)

Parameters:

ioc - ioc

getDsId

public Object getDsId()

Specified by:

getDsId in interface Commentable

Specified by:

getDsId in interface Inspectable

Returns:

something