|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.datacrow.core.modules.xml.XmlObject
net.datacrow.core.modules.xml.XmlModule
public class XmlModule
A XML representation of a module.
Constructor Summary | |
---|---|
XmlModule()
Creates an empty instance. |
|
XmlModule(byte[] xml)
Creates a new instance. |
|
XmlModule(XmlModule template)
Create a new module based on the provided existing XML module. |
Method Summary | |
---|---|
boolean |
canBeLend()
Tells if items belonging to this module can be lend. |
int |
getChildIndex()
Retrieves the child module index. |
int |
getDefaultSortFieldIdx()
The field to be sorted / ordered on by default. |
java.lang.String |
getDescription()
The description for this module. |
int |
getDisplayIndex()
The position of this module as displayed in the module bar. |
org.w3c.dom.Document |
getDocument()
The XML document. |
java.util.Collection<XmlField> |
getFields()
Retrieves the XML field definitions. |
byte[] |
getIcon16()
The small icon bytes. |
java.lang.String |
getIcon16Filename()
Retrieves the small icon file name. |
byte[] |
getIcon32()
The large icon bytes. |
java.lang.String |
getIcon32Filename()
Retrieves the large icon file name. |
java.lang.Class |
getImporter()
Retrieves the file importer class. |
int |
getIndex()
The unique index of the module. |
java.lang.String |
getJarFilename()
Retrieves the JAR filename in which this module is / will be stored. |
javax.swing.KeyStroke |
getKeyStroke()
The key combination associated with this module. |
java.lang.String |
getLabel()
The display label. |
java.lang.Class |
getModuleClass()
The module class. |
java.lang.String |
getName()
The internal name. |
int |
getNameFieldIdx()
Retrieves the index for the field which holds the name of an item. |
java.lang.Class |
getObjectClass()
Returns the items object class. |
java.lang.String |
getObjectName()
System name for items belonging to this module. |
java.lang.String |
getObjectNamePlural()
System plural name for items belonging to this module. |
int |
getParentIndex()
The parent module index. |
java.lang.String |
getProductVersion()
Retrieves the Data Crow version number for which this module has been created. |
java.lang.Class |
getSynchronizer()
The synchronize class (or mass update). |
java.lang.String |
getTableName()
The database table name. |
java.lang.String |
getTableNameShort()
The database table short name. |
boolean |
hasDependingModules()
Indicates if other modules are depending on this module. |
boolean |
hasInsertView()
Indicates if the module support insert views. |
boolean |
hasSearchView()
Indicates if the module support search views. |
boolean |
isChanged()
Indicates if customizations have been made. |
boolean |
isContainerManaged()
Indicates if items belonging to this module can be part of a container. |
boolean |
isEnabled()
Is the module enabled? |
boolean |
isFileBacked()
Indicates if items belonging to this module are file based. |
boolean |
isServingMultipleModules()
Indicates if multiple modules are using this module. |
void |
setCanBeLend(boolean canBeLend)
Indicate if items belonging to this module can be lend. |
void |
setChildIndex(int childIndex)
Indicate which module is the child for this module. |
void |
setContainerManaged(boolean isContainerManaged)
Indicate if items belonging to this module can be part of a container. |
void |
setDefaultSortFieldIdx(int defaultSortFieldIdx)
Set the default field to sort / order on. |
void |
setDescription(java.lang.String description)
Set the description for this module. |
void |
setDisplayIndex(int displayIndex)
Set the module bar position for this module. |
void |
setDocument(org.w3c.dom.Document document)
Set the XML document. |
void |
setEnabled(boolean enabled)
Mark the field as enabled. |
void |
setFields(java.util.Collection<XmlField> fields)
Set the XML field definitions. |
void |
setFileBacked(boolean isFileBacked)
Indicate if items belonging to this module are file based. |
void |
setHasDependingModules(boolean hasDependingModules)
Indicate if other modules are depending on this module. |
void |
setHasInsertView(boolean hasInsertView)
Indicate if the insert view is supported. |
void |
setHasSearchView(boolean hasSearchView)
Indicate if the search view is supported. |
void |
setIcon16(byte[] b)
Set the small icon bytes. |
void |
setIcon16Filename(java.lang.String icon16Filename)
Sets the small icon filename. |
void |
setIcon32(byte[] b)
Set the large icon bytes. |
void |
setIcon32Filename(java.lang.String icon32Filename)
Sets the large icon filename. |
void |
setImporter(java.lang.Class importer)
Sets the file imported class. |
void |
setIndex(int index)
Set the unique index for this module. |
void |
setKeyStroke(javax.swing.KeyStroke keyStroke)
Set the key combination to activate this module. |
void |
setLabel(java.lang.String label)
Sets the display label. |
void |
setModuleClass(java.lang.Class moduleClass)
Set the module class. |
void |
setName(java.lang.String name)
The system name of this module. |
void |
setNameFieldIdx(int nameFieldIdx)
Indicate which field holds the name of an item. |
void |
setObject(java.lang.Class object)
Sets the object class. |
void |
setObjectName(java.lang.String objectName)
Sets the system name for items belonging to this module. |
void |
setObjectNamePlural(java.lang.String objectNamePlural)
Sets the system plural name for items belonging to this module. |
void |
setParentIndex(int parentIndex)
Indicate which module is the parent of this module. |
void |
setProductVersion(java.lang.String productVersion)
Sets the Data Crow version number for which this module has been created. |
void |
setServingMultipleModules(boolean isServingMultipleModules)
Indicate if multiple modules are using this module. |
void |
setSynchronizer(java.lang.Class synchronizer)
Set the synchronize class (or mass update). |
void |
setTableName(java.lang.String tableName)
Sets the database table name. |
void |
setTableNameShort(java.lang.String tableNameShort)
Sets the database table short name. |
Methods inherited from class net.datacrow.core.modules.xml.XmlObject |
---|
getClass |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XmlModule()
public XmlModule(XmlModule template)
template
- public XmlModule(byte[] xml) throws InvalidModuleXmlException, ModuleUpgradeException
xml
- The XML file byte content
InvalidModuleXmlException
ModuleUpgradeException
Method Detail |
---|
public boolean isChanged()
public boolean canBeLend()
public int getChildIndex()
public java.lang.String getDescription()
public org.w3c.dom.Document getDocument()
public boolean isEnabled()
public java.util.Collection<XmlField> getFields()
public boolean hasInsertView()
public boolean hasSearchView()
public java.lang.Class getImporter()
FileImporter
public int getIndex()
public javax.swing.KeyStroke getKeyStroke()
public java.lang.String getLabel()
public java.lang.String getName()
public java.lang.Class getObjectClass()
public java.lang.String getObjectName()
public java.lang.String getObjectNamePlural()
public java.lang.Class getModuleClass()
public java.lang.Class getSynchronizer()
DefaultSynchronizer
public java.lang.String getTableName()
public java.lang.String getTableNameShort()
public boolean hasDependingModules()
public int getDisplayIndex()
public int getDefaultSortFieldIdx()
public int getParentIndex()
public int getNameFieldIdx()
public void setCanBeLend(boolean canBeLend)
canBeLend
- public void setChildIndex(int childIndex)
childIndex
- The module index of the child.public void setDefaultSortFieldIdx(int defaultSortFieldIdx)
defaultSortFieldIdx
- The field index.public void setDescription(java.lang.String description)
description
- public void setDisplayIndex(int displayIndex)
displayIndex
- public void setDocument(org.w3c.dom.Document document)
document
- public void setEnabled(boolean enabled)
enabled
- public void setFields(java.util.Collection<XmlField> fields)
fields
- public void setHasDependingModules(boolean hasDependingModules)
hasDependingModules
- public void setHasInsertView(boolean hasInsertView)
hasInsertView
- public void setHasSearchView(boolean hasSearchView)
hasSearchView
- public void setImporter(java.lang.Class importer)
importer
- public void setIndex(int index)
index
- public void setKeyStroke(javax.swing.KeyStroke keyStroke)
keyStroke
- public void setLabel(java.lang.String label)
label
- public void setModuleClass(java.lang.Class moduleClass)
moduleClass
- public void setName(java.lang.String name)
name
- public void setNameFieldIdx(int nameFieldIdx)
nameFieldIdx
- The field index.public void setObject(java.lang.Class object)
object
- public void setObjectName(java.lang.String objectName)
objectName
- public void setObjectNamePlural(java.lang.String objectNamePlural)
objectNamePlural
- public void setParentIndex(int parentIndex)
parentIndex
- The module index.public void setSynchronizer(java.lang.Class synchronizer)
synchronizer
- public void setTableName(java.lang.String tableName)
tableName
- public void setTableNameShort(java.lang.String tableNameShort)
tableNameShort
- public java.lang.String getIcon16Filename()
public void setIcon16Filename(java.lang.String icon16Filename)
icon16Filename
- public java.lang.String getIcon32Filename()
public void setIcon32Filename(java.lang.String icon32Filename)
icon32Filename
- public boolean isFileBacked()
public void setFileBacked(boolean isFileBacked)
isFileBacked
- public boolean isContainerManaged()
public void setContainerManaged(boolean isContainerManaged)
isContainerManaged
- public boolean isServingMultipleModules()
public void setServingMultipleModules(boolean isServingMultipleModules)
isServingMultipleModules
- public java.lang.String getJarFilename()
public byte[] getIcon16()
public byte[] getIcon32()
public void setIcon16(byte[] b)
b
- The icon.public void setIcon32(byte[] b)
b
- The icon.public java.lang.String getProductVersion()
public void setProductVersion(java.lang.String productVersion)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |