|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.cosylab.vdct.plugins.NameConfigExample
public class NameConfigExample
This NameConfigPlugin example checks the record names using a pattern loaded from an xml file.
The file name is defined by VDCT_NAME_CONFIG_FILE filename located in user home directory
(or in VDCT_CONFIG_DIR dir). Use VDCT_NAME_CONFIG_FILE_ENV environment variable to override
this default setting.
An example of XML file:
Field Summary | |
---|---|
static java.lang.String |
VDCT_NAME_CONFIG_FILE
|
static java.lang.String |
VDCT_NAME_CONFIG_FILE_ENV
|
Constructor Summary | |
---|---|
NameConfigExample()
|
Method Summary | |
---|---|
java.lang.String |
checkValidity(java.lang.String name)
If name is valid, the function returns null, otherwise it returns a String with the description of the error. |
void |
destroy()
Insert the method's description here. |
java.lang.String |
getAuthor()
Insert the method's description here. |
java.lang.String |
getDefaultName()
Returns the default name. |
java.lang.String |
getDescription()
Insert the method's description here. |
java.lang.String |
getName()
Insert the method's description here. |
java.lang.String |
getNameDescription()
Returns the description of the valid names. |
java.lang.String |
getVersion()
Insert the method's description here. |
void |
init(java.util.Properties properties,
PluginContext context)
Insert the method's description here. |
boolean |
isRunning()
Returns true if the plugin has not been stopped since the last start. |
void |
start()
Insert the method's description here. |
void |
stop()
Insert the method's description here. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String VDCT_NAME_CONFIG_FILE
public static final java.lang.String VDCT_NAME_CONFIG_FILE_ENV
Constructor Detail |
---|
public NameConfigExample()
Method Detail |
---|
public java.lang.String checkValidity(java.lang.String name)
NameConfigPlugin
checkValidity
in interface NameConfigPlugin
public java.lang.String getDefaultName()
getDefaultName
in interface NameConfigPlugin
public java.lang.String getNameDescription()
NameConfigPlugin
getNameDescription
in interface NameConfigPlugin
public boolean isRunning()
NameConfigPlugin
isRunning
in interface NameConfigPlugin
public void destroy()
Plugin
destroy
in interface Plugin
public java.lang.String getAuthor()
Plugin
getAuthor
in interface Plugin
public java.lang.String getDescription()
Plugin
getDescription
in interface Plugin
public java.lang.String getName()
Plugin
getName
in interface Plugin
public java.lang.String getVersion()
Plugin
getVersion
in interface Plugin
public void init(java.util.Properties properties, PluginContext context)
Plugin
init
in interface Plugin
public void start()
Plugin
start
in interface Plugin
public void stop()
Plugin
stop
in interface Plugin
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |