|
LEONARDI Application Composer - 8.9.0.40 by W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectleon.info.LyTag
leon.info.LyInfo
leon.info.LyObjectInfo
public abstract class LyObjectInfo
This class is an abstract class that contains generic behavior of the classes which represent the data information read from the data model description file. These classes are : LyClassInfo, LyFieldInfo, LyAction, LyProject, LyFilter and LySort. This class inherits from LyInfo class : this means that instances of this class have an id and belong to an application. The information added on this class is the following :
Accessors are given to access all these attributes. But they can only be set by the parser when reading the data description file.
Additionally this class implements the Cloneable interface : this means that all subclasses may need to override the clone() method (from Object) to duplicated some of the information they have in reference.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class leon.info.LyTag |
---|
LyTag.Model |
Field Summary | |
---|---|
static java.lang.String |
__VERSION
|
static java.lang.String |
NULL
|
static int |
PART_ALL
|
static int |
PART_BIND
|
static int |
PART_DATA
|
static int |
PART_GUI
|
static int |
PART_LABEL
|
Method Summary | |
---|---|
java.lang.Object |
clone()
Implementation of the Cloneable interface. |
java.lang.String |
getAlias()
Accessor for alias (shortname) of this instance. |
java.lang.Object |
getData(java.lang.Object name)
Gets a user data by its name. |
java.util.Vector<LyData> |
getDataList()
Gets list of data associated to this instance. |
java.util.Hashtable<java.lang.Object,LyData> |
getDatas()
Gets table of data associated to this instance. |
java.lang.String |
getFilePrefix()
Accessor to the file prefix for this instance. |
java.lang.String |
getGroup()
Returns name of the group to which this instance belongs. |
java.lang.String |
getInternalAlias()
Accessor for alias (shortname) of this instance. |
java.lang.String |
getInternalFilePrefix()
Accessor to the file prefix for this instance. |
java.lang.String |
getInternalName()
Accessor for name of this instance. |
java.util.BitSet |
getMarks()
Accessor to the marks attached to this instance (presented as a bitset). |
java.lang.String |
getName()
Accessor for name of this instance. |
LyObjectInfo |
getTemplate()
Returns the template used to initialize this instance. |
java.lang.String |
getTip()
Returns the tip (short help displayed in tool tip) associated to this instance. |
java.lang.Object |
getUserData()
Gets user data associated to this class info. |
boolean |
hasMark(int mark)
Check if a mark is set on this instance. |
boolean |
hasMarks(java.util.BitSet testMarks,
boolean matchAll)
Check if a group of marks are set on this instance. |
boolean |
hasTemplate(LyObjectInfo objectInfo)
Checks recursively if this object has the given object as template. |
boolean |
isTemplate()
Checks if this object info was used as template. |
java.lang.Object |
putData(java.lang.Object name,
java.lang.Object value)
Adds user data on this instance. |
java.lang.Object |
putData(java.lang.Object name,
java.lang.Object value,
LyTag.Model modelType)
Adds user data on this instance. |
java.lang.Object |
removeData(java.lang.Object name)
Removes a user data on this instance. |
java.lang.String |
toName()
Converts this objectInfo to a string. |
Methods inherited from class leon.info.LyInfo |
---|
getApplication, getFile, getId, getInclude, isIncluded, isInternal, isInternal, isLoaded, isLocked, load, setApplication, setFile, toString |
Methods inherited from class leon.info.LyTag |
---|
getCommentsEnd, getCommentsStart, getEnvironment, getModelType, getParent, getRootProject, hasAncestor, isExtern, setCommentsEnd, setCommentsStart, wasCloned |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface leon.parser.LyCommentInterface |
---|
getCommentsEnd, getCommentsStart, setCommentsEnd, setCommentsStart |
Field Detail |
---|
public static final java.lang.String __VERSION
public static final int PART_DATA
public static final int PART_BIND
public static final int PART_GUI
public static final int PART_LABEL
public static final int PART_ALL
public static final java.lang.String NULL
Method Detail |
---|
public java.lang.String toName()
public final boolean hasMark(int mark)
mark
- Mark tested for this object.
public final boolean hasMarks(java.util.BitSet testMarks, boolean matchAll)
testMarks
- Tested marks.matchAll
- Specifies if this instance have to match all specified marks or only one.
public final java.lang.Object putData(java.lang.Object name, java.lang.Object value)
name
- Name of the user data. If a value was already stored for that name, this
value is overridden.value
- Value of the user data.
java.lang.IllegalArgumentException
- If the given name or value is null.public final java.lang.Object putData(java.lang.Object name, java.lang.Object value, LyTag.Model modelType)
name
- Name of the user data. If a value was already stored for that name, this
value is overridden.value
- Value of the user data.modelType
- Model type where the data is declared.
java.lang.IllegalArgumentException
- If the given name or value is null.public final java.lang.Object removeData(java.lang.Object name)
name
- Name of the data to be removed.
java.lang.IllegalArgumentException
- If the given name is null.
java.lang.IllegalStateException
- If this method is called before any data has been added
(data hashtable is null).public java.lang.Object clone()
clone
in class LyTag
public final java.lang.String getName()
getName
in class LyInfo
public final java.lang.String getInternalName()
public final java.lang.String getAlias()
getAlias
in class LyInfo
public final java.lang.String getInternalAlias()
public final java.lang.String getFilePrefix()
public final java.lang.String getInternalFilePrefix()
public final LyObjectInfo getTemplate()
public final java.lang.String getGroup()
public final java.util.BitSet getMarks()
BitSet
public java.lang.String getTip()
public final java.lang.Object getData(java.lang.Object name)
name
- Name for which a value is searched.
java.lang.IllegalArgumentException
- If the given name is null.public final java.util.Vector<LyData> getDataList()
public final java.util.Hashtable<java.lang.Object,LyData> getDatas()
public java.lang.Object getUserData()
public boolean hasTemplate(LyObjectInfo objectInfo)
public boolean isTemplate()
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |