|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.etools.systems.core.ui.uda.SystemXMLElementWrapper
This is a base class for classes that wrapper xml elements. Eg, there are child classes to represent action xml elements, and type xml elements.
Field Summary | |
---|---|
static String |
copyright
|
protected Element |
elm
|
Fields inherited from interface com.ibm.etools.systems.core.ui.uda.ISystemUDAConstants |
---|
NAME_ATTR, ORIGINAL_NAME_ATTR, RELEASE_ATTR, XE_DOMAIN, XE_DOMNAME, XE_DOMTYPE |
Constructor Summary | |
---|---|
SystemXMLElementWrapper(Element elm,
SystemUDBaseManager mgr,
SystemProfile profile,
int domainType)
Constructor |
Method Summary | |
---|---|
void |
deleteElement()
Delete this element from the document |
static Element |
findChildByName(Element parentElement,
Document xdoc,
String tagName,
String searchName)
For unique-name checking. |
Object |
getAdapter(Class adapterType)
As required by the IAdaptable interface. |
String |
getAttribute(String attr,
String defaultValue)
Set the text value of the given attribute. |
boolean |
getBooleanAttribute(String attr)
Return the boolean value of a given attribute. |
boolean |
getBooleanAttribute(String attr,
boolean defaultValue)
Return the boolean value of a given attribute. |
Vector |
getChildren(Vector children,
Element parentElement,
Document xdoc,
SystemProfile profile)
Given a parent element XML node, returns wrappers of all child tags of which we are interested Always returns a non-null vector, although it may be empty |
static Vector |
getChildren(Vector children,
Element parentElement,
Document xdoc,
SystemProfile profile,
ISystemXMLElementWrapperFactory factory,
int domain)
Given a parent element XML node, returns wrappers all child tag elements with the given tag name Always returns a non-null vector, although it may be empty. |
Vector |
getChildren(Vector children,
SystemProfile profile)
Returns element wrappers of children (if this is a domain) or siblings |
protected Element |
getChildTag(String tagname,
boolean create)
Given a tag name, return the xml node for that child tag |
Document |
getDocument()
Get the document this element is a part of |
int |
getDomain()
Return the domain this element is in, or represents if it is a domain element itself. |
Element |
getElement()
Get the XML document element this node wraps |
Vector |
getExistingNames()
For unique-name checking. |
Vector |
getExistingNames(Element parentElement,
Document xdoc)
For unique-name checking. |
static Vector |
getExistingNames(Element parentElement,
Document xdoc,
String tagName)
For unique-name checking. |
abstract Image |
getImage()
|
SystemUDBaseManager |
getManager()
Get the manager that manages the document this element is part of. |
String |
getName()
Return the value of this node's "Name" attribute |
String |
getOriginalName()
For IBM-supplied elements that have been edited, returns the original IBM-supplied name |
Element |
getParentDomainElement()
Get the parent xml domain element of this element. |
Element |
getParentElement()
Get the parent xml element of this element. |
SystemProfile |
getProfile()
Get the profile this is associated with |
protected abstract String |
getTagName()
|
protected String |
getTextNode(String tagname)
Given the name of a child xml tag, return the data for that tag |
String |
getVendor()
Get the name of the vendor who supplied this user action or type. |
boolean |
isDomain()
Is this a "Domain" tag? |
boolean |
isIBM()
Return the value of this node's "IBM" attribute. |
boolean |
isUserChanged()
Return the value of this node's "user-changed" attribute. |
void |
setAttribute(String attr,
String value)
Set the text value of the given attribute to a given value |
void |
setBooleanAttribute(String attr,
boolean b)
Set the value of a boolean attribute |
void |
setIBM(boolean isFromIBM)
Set the value of this tag's "Vendor" attribute to "IBM", or clear the IBM attribute (after a duplication action for example). |
void |
setName(String s)
Set the value of this tag's "Name" attribute. |
protected void |
setTextNode(String tagname,
String val)
Given the name of a child xml tag and a data value, update the data of that tag |
void |
setUserChanged(boolean isUserChanged)
Set the value of this tag's "user-changed" attribute |
void |
setVendor(String vendor)
Set the name of the vendor who supplied this user action or type |
String |
toString()
Convert to a string Same as calling getName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String copyright
protected Element elm
Constructor Detail |
public SystemXMLElementWrapper(Element elm, SystemUDBaseManager mgr, SystemProfile profile, int domainType)
elm
- - The actual xml document element for this action/typemgr
- - The parent manager of these actions/typesprofile
- - The system profile which owns this actiondomainType
- - The integer representation of the domain this is in (or this is, for a domain element)Method Detail |
protected abstract String getTagName()
public abstract Image getImage()
public String toString()
public Object getAdapter(Class adapterType)
getAdapter
in interface IAdaptable
IAdaptable.getAdapter(Class)
public SystemProfile getProfile()
public SystemUDBaseManager getManager()
public Element getElement()
public Document getDocument()
public Element getParentDomainElement()
public Element getParentElement()
public boolean isDomain()
public int getDomain()
public String getName()
public void setName(String s)
public String getOriginalName()
public boolean isIBM()
public void setVendor(String vendor)
public String getVendor()
public void setIBM(boolean isFromIBM)
public boolean isUserChanged()
public void setUserChanged(boolean isUserChanged)
public void deleteElement()
protected String getTextNode(String tagname)
protected void setTextNode(String tagname, String val)
protected Element getChildTag(String tagname, boolean create)
tagname
- - the name of the tag to findcreate
- - true if tag is to be created if not foundpublic void setBooleanAttribute(String attr, boolean b)
public boolean getBooleanAttribute(String attr)
attr
- - name of the attribute to querypublic boolean getBooleanAttribute(String attr, boolean defaultValue)
attr
- - name of the attribute to querydefaultValue
- - value to return if the attribute is not foundpublic String getAttribute(String attr, String defaultValue)
public void setAttribute(String attr, String value)
public Vector getExistingNames()
public Vector getExistingNames(Element parentElement, Document xdoc)
public static Vector getExistingNames(Element parentElement, Document xdoc, String tagName)
public Vector getChildren(Vector children, SystemProfile profile)
public Vector getChildren(Vector children, Element parentElement, Document xdoc, SystemProfile profile)
public static Vector getChildren(Vector children, Element parentElement, Document xdoc, SystemProfile profile, ISystemXMLElementWrapperFactory factory, int domain)
public static Element findChildByName(Element parentElement, Document xdoc, String tagName, String searchName)
|
Remote Systems v6.4.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |