org.mixer2.xhtml

Class AbstractJaxb

java.lang.Object

org.mixer2.xhtml.AbstractJaxb

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AContent, Address, Applet, Area, Base, Basefont, Br, ButtonContent, Col, Colgroup, Command, Datalist, Details, Dir, Dl, Embed, Fieldset, Flow, FormContent, Head, Hgroup, Hr, Html, Img, Inline, Input, Isindex, Keygen, Link, Map, Menu, Meta, Object, Ol, Optgroup, Option, Param, PreContent, Script, Select, Source, Style, Table, Tbody, Textarea, Tfoot, Thead, Title, Tr, Track, Ul, Wbr

public abstract class AbstractJaxb
extends Object
implements Serializable

base class of all tag type

Author:

nabedge

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractJaxb()

Method Summary

Modifier and Type	Method and Description
<T extends AbstractJaxb> void	addCssClass(String clazz) add class attribute.
<T> T	cast(Class<T> clazz) type cast.
<T extends AbstractJaxb> T	copy(Class<T> tagType) return deep copy of myself
<T extends AbstractJaxb> T	copyNoException(Class<T> tagType) same as copy(Class) but never throw exception.
String	getAria(String key) return the value of area-* attribute.
<T extends AbstractJaxb> T	getById(String id) get tag that has specified id attribute.
<T extends AbstractJaxb> T	getById(String id, Class<T> tagType) get tag that has specified id attribute.
<T extends AbstractJaxb> T	getByName(String name, Class<T> tagType) find tag by "name" property.
<T extends AbstractJaxb> List<T>	getByNameAsList(String name, Class<T> tagType) find tag by "name" property returning as List.
List<String>	getCssClass() return class attribute as List.
String	getData(String key) return the value of data-* attribute.
<T extends AbstractJaxb> List<T>	getDescendants(Class<T> tagType) scan descendant elements that has specified tag type and return it as List.
<T extends AbstractJaxb> List<T>	getDescendants(String clazz) scan descendant elements that has specified class attribute and return it as List
<T extends AbstractJaxb> List<T>	getDescendants(String clazz, Class<T> tagType) scan descendant element that is specified tag type having specified class attribute and return it as List.
Footer	getFooter() get footer tag (the first one in this tag)
List<Footer>	getFooterAsList() get footer tag
Header	getHeader() get header tag (the first one in this tag)
List<Header>	getHeaderAsList() get header tag
String	getId() get id attribute.
Map<QName,String>	getOtherAttributes() get other attribute map.
String	getStyle() NOTICE: this method is dummy for make coding easy.
TreeMap<String,String>	getStyleAsTreeMap() return style attributes as TreeMap
<T extends AbstractJaxb> boolean	hasCssClass(String clazz) return true if have specified class attribute.
boolean	insertAfterId(String id, String insString) insert String after the element having specified id attribute
<T extends AbstractJaxb> boolean	insertAfterId(String id, T insObject) insert element after the element having specified id attribute.
boolean	insertBeforeId(String id, String insString) insert string before the element having specified id attribute.
<T extends AbstractJaxb> boolean	insertBeforeId(String id, T insObject) insert element before the element having specified id attribute.
boolean	isSetId() NOTICE: this method is dummy for make coding easy.
<T extends AbstractJaxb> boolean	remove(T target) delete element that has specified attribute within descendant element of oneself.
String	removeAria(String key) remove a specified aria-* attribute.
boolean	removeById(String id) delete element that has specified id attribute within descendant element of oneself.
<T extends AbstractJaxb> void	removeCssClass(String clazz) remove specified class attribute if having it.
String	removeData(String key) remove a specified data-* attribute.
<T extends AbstractJaxb> void	removeDescendants(Class<T> tagType) delete all descendant elements that is specified tag type.
<T extends AbstractJaxb> void	removeDescendants(String clazz) delete all descendant elements having specified class attribute
<T extends AbstractJaxb> void	removeDescendants(String clazz, Class<T> tagType) delete all descendant elements that is specified tag type having specified class attribute.
void	removeEmptyCssClass() Remove class attribute if it has no value.
void	removeInner() remove inner content of this tag.
<T extends AbstractJaxb> boolean	replace(T target, T replacement) replace element that has specified attribute within descendant element of oneself.
<T extends AbstractJaxb> boolean	replaceById(String id, String replacement) replace element by string.
<T extends AbstractJaxb> boolean	replaceById(String id, T replacement) replace element that has specified id attribute within descendant element of oneself.
<T extends AbstractJaxb> void	replaceDescendants(Class<T> tagType, String replacement) replace all descendant element that is specified tag type by String
<T extends AbstractJaxb> void	replaceDescendants(Class<T> tagType, T replacement) replace all descendant elements that is specified tag type.
<T extends AbstractJaxb> void	replaceDescendants(String clazz, Class<T> tagType, String replacement) replace all the descendant elements by String.
<T extends AbstractJaxb> void	replaceDescendants(String clazz, Class<T> tagType, T replacement) replace all the descendant elements that is specified tag type having specified class attribute.
<T extends AbstractJaxb> void	replaceDescendants(String clazz, String replacement) replace descendant tag with string.
<T extends AbstractJaxb> void	replaceDescendants(String clazz, T replacement) replace all descendant elements that has specified class attribute.
void	replaceInner(List<? extends Object> replacement) Replace whole of inside the tag by the whole elements of the list. If the element can not be use in this tag, There is a case that will be exclude.
void	replaceInner(String replacement) Replace whole of inside the tag by replacement. If this tag can not have String directory (ex.
<T extends AbstractJaxb> void	replaceInner(T replacement) Replace whole of inside the tag by replacement. For various reasons, this method does NOT use deep copy of replacement. It is recommended to use copy(T) in method argument.
void	setAria(String key, String value) set area-* attribute
void	setData(String key, String value) set data-* attribute
void	setId(String id) set id attribute.
void	setStyle(String value) NOTICE: this method is dummy for make coding easy.
<T extends AbstractJaxb> void	setStyleByTreeMap(TreeMap<String,String> styleMap) write style attribute by TreeMap
byte[]	toByteArray() returns byte sequence of myself.
String	toString() FOR DEBUG.
void	unsetAllId() remove id attribute of all descendant elements.
void	unsetAllId(Pattern pattern) remove id attribute that matches specified regex.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJaxb

public AbstractJaxb()

Method Detail

cast

public <T> T cast(Class<T> clazz)

type cast.

 // usage:
 // get a TD tag of first row, first column.
 Td td = html.getById("foo", Table.class).getTr().get(0).getThOrTd().get(0)
         .cast(Td.class);
 

Parameters:

clazz - tag type of org.mixer2.jaxb.xhtml.*

Returns:

getById

public <T extends AbstractJaxb> T getById(String id,
                                          Class<T> tagType)
                                   throws TagTypeUnmatchException

get tag that has specified id attribute. You don't need to cast() because you can specify the tag type.

 // sample: get a Div tag having id="foo" attribute.
 html.getById("foo", Div.class);
 

Parameters:

id -

tagType -

Returns:

Throws:

TagTypeUnmatchException

getById

public <T extends AbstractJaxb> T getById(String id)

get tag that has specified id attribute. To use return value as ussual tag, you must cast() it.

Parameters:

id -

Returns:

remove

public <T extends AbstractJaxb> boolean remove(T target)

delete element that has specified attribute within descendant element of oneself. you can't delete oneself.

Parameters:

target -

Returns:

if success to delete, return true. if no hit, return false.

removeInner

public void removeInner()

remove inner content of this tag.

removeById

public boolean removeById(String id)

delete element that has specified id attribute within descendant element of oneself. you can't delete oneself.

Parameters:

id -

Returns:

replace

public <T extends AbstractJaxb> boolean replace(T target,
                                                T replacement)
                                         throws TagTypeUnmatchException

replace element that has specified attribute within descendant element of oneself. you can't replace oneself. It will be replaced by deep copy of "replacement"

Parameters:

target -

replacement -

Returns:

if success to replace, return true. if no hit, return false.

Throws:

TagTypeUnmatchException

replaceById

public <T extends AbstractJaxb> boolean replaceById(String id,
                                                    T replacement)
                                             throws TagTypeUnmatchException

replace element that has specified id attribute within descendant element of oneself. you can't replace oneself. It will be replaced by deep copy of "replacement"

Parameters:

id -

replacement -

Returns:

if success to replace, return true. if no hit, return false.

Throws:

TagTypeUnmatchException

replaceById

public <T extends AbstractJaxb> boolean replaceById(String id,
                                                    String replacement)
                                             throws TagTypeUnmatchException

replace element by string. you can't replace oneself.

Parameters:

id -

replacement -

Returns:

if success to replace, return true. if no hit, return false.

Throws:

TagTypeUnmatchException

getDescendants

public <T extends AbstractJaxb> List<T> getDescendants(String clazz,
                                                       Class<T> tagType)

scan descendant element that is specified tag type having specified class attribute and return it as List.

 // usage:
 // get all div objects having "foo" class
 List<Div> divList = html.getDescendants("foo", Div.class);
 // get all Table objects having "bar" class within <div id="foo">
 List<Table> tbList = html.getById("foo", Div.class).getDescendants("bar",
         Table.class);
 

Parameters:

clazz -

tagType -

Returns:

getDescendants

public <T extends AbstractJaxb> List<T> getDescendants(Class<T> tagType)

scan descendant elements that has specified tag type and return it as List.

 // usage:
 // get all div objects.
 html.getDescendants(Div.class);
 // get all table objects within <div id="foo">
 html.getById("foo", Div.class).getDescendants(Table.class);
 

Parameters:

tagType -

Returns:

getDescendants

public <T extends AbstractJaxb> List<T> getDescendants(String clazz)

scan descendant elements that has specified class attribute and return it as List

Parameters:

clazz - class attribute

Returns:

removeDescendants

public <T extends AbstractJaxb> void removeDescendants(String clazz,
                                                       Class<T> tagType)

delete all descendant elements that is specified tag type having specified class attribute.

Parameters:

clazz - class attribute

tagType -

removeDescendants

public <T extends AbstractJaxb> void removeDescendants(Class<T> tagType)

delete all descendant elements that is specified tag type.

Parameters:

tagType -

removeDescendants

public <T extends AbstractJaxb> void removeDescendants(String clazz)

delete all descendant elements having specified class attribute

Parameters:

clazz - class attribute

replaceDescendants

public <T extends AbstractJaxb> void replaceDescendants(String clazz,
                                                        Class<T> tagType,
                                                        T replacement)
                                                 throws TagTypeUnmatchException

replace all the descendant elements that is specified tag type having specified class attribute. this method use deep copy of "replacement"

Parameters:

clazz - class attribute

tagType -

replacement -

Throws:

TagTypeUnmatchException

replaceDescendants

public <T extends AbstractJaxb> void replaceDescendants(String clazz,
                                                        Class<T> tagType,
                                                        String replacement)
                                                 throws TagTypeUnmatchException

replace all the descendant elements by String. The target is specified tag type having specified class attribute.

Parameters:

clazz - class attribute

tagType -

replacement -

Throws:

TagTypeUnmatchException

replaceDescendants

public <T extends AbstractJaxb> void replaceDescendants(Class<T> tagType,
                                                        T replacement)
                                                 throws TagTypeUnmatchException

replace all descendant elements that is specified tag type. This method use deep copy of "replacement"

Parameters:

tagType -

replacement -

Throws:

TagTypeUnmatchException

replaceDescendants

public <T extends AbstractJaxb> void replaceDescendants(String clazz,
                                                        T replacement)
                                                 throws TagTypeUnmatchException

replace all descendant elements that has specified class attribute. This method user deep copy of "replacement"

Parameters:

clazz - class attribute

replacement -

Throws:

TagTypeUnmatchException

replaceDescendants

public <T extends AbstractJaxb> void replaceDescendants(Class<T> tagType,
                                                        String replacement)
                                                 throws TagTypeUnmatchException

replace all descendant element that is specified tag type by String

指定したタグ型の子孫要素を文字列で置換します。

Parameters:

tagType -

replacement -

Throws:

TagTypeUnmatchException

replaceDescendants

public <T extends AbstractJaxb> void replaceDescendants(String clazz,
                                                        String replacement)
                                                 throws TagTypeUnmatchException

replace descendant tag with string. specifying class property.

Parameters:

clazz - class attribute

replacement -

Throws:

TagTypeUnmatchException

replaceInner

public <T extends AbstractJaxb> void replaceInner(T replacement)

Replace whole of inside the tag by replacement.
For various reasons, this method does NOT use deep copy of replacement.
It is recommended to use copy(T) in method argument.

recommended pattern.

 // div and p is instance of Div, p tag object.
 Div div = TagCreator.div();
 P p = TagCreator.p();
 p.getContent().add("foo");
 div.replaceInner(p.copy(P.class)); // *** using copy()
 p.getContent().add("bar");
 System.out.println(mixer2Engine.saveToString(div));
 // you get <div><p>foo</p></div>
 

anti pattern. use with caution.

 // divA and divB is instance of Div tag object.
 Div div = TagCreator.div();
 P p = TagCreator.p();
 p.getContent().add("foo");
 div.replaceInner(p); // *** without copy()
 p.getContent().add("bar");
 System.out.println(mixer2Engine.saveToString(div));
 // you get <div><p>foo bar</p></div>
 

Parameters:

replacement -

replaceInner

public void replaceInner(String replacement)

Replace whole of inside the tag by replacement.
If this tag can not have String directory (ex. <table> tag), do nothing.

Parameters:

replacement -

replaceInner

public void replaceInner(List<? extends Object> replacement)

Replace whole of inside the tag by the whole elements of the list.
If the element can not be use in this tag, There is a case that will be exclude.

Parameters:

replacement -

insertAfterId

public <T extends AbstractJaxb> boolean insertAfterId(String id,
                                                      T insObject)
                                               throws TagTypeUnmatchException

insert element after the element having specified id attribute. This method use deep copy of "insObject"

Parameters:

id - id attribute

insObject -

Returns:

true if success to insert. if no hit, return false.

Throws:

TagTypeUnmatchException

insertAfterId

public boolean insertAfterId(String id,
                             String insString)
                      throws TagTypeUnmatchException

insert String after the element having specified id attribute

Parameters:

id -

insString -

Returns:

true if success to insert. if no hit, return false.

Throws:

TagTypeUnmatchException

insertBeforeId

public <T extends AbstractJaxb> boolean insertBeforeId(String id,
                                                       T insObject)
                                                throws TagTypeUnmatchException

insert element before the element having specified id attribute. This method use deep copy of insObject

Parameters:

id -

insObject -

Returns:

true if success to insert. if no hit, return false.

Throws:

TagTypeUnmatchException

insertBeforeId

public boolean insertBeforeId(String id,
                              String insString)
                       throws TagTypeUnmatchException

insert string before the element having specified id attribute.

Parameters:

id -

insString -

Returns:

true if success to insert. if no hit, return false.

Throws:

TagTypeUnmatchException

setStyleByTreeMap

public <T extends AbstractJaxb> void setStyleByTreeMap(TreeMap<String,String> styleMap)

write style attribute by TreeMap

 // usage:
 TreeMap<String, String> styleMap = new TreeMap<String, String>();
 styleMap.put("border-color", "red");
 html.getById(Div.class, "hellomsg").setStyleByTreeMap(styleMap);
 // output:
 // <div id="hellomsg" style="border-color:red;">...</div>
 

Parameters:

styleMap -

getStyleAsTreeMap

public TreeMap<String,String> getStyleAsTreeMap()

return style attributes as TreeMap

Returns:

copy

public <T extends AbstractJaxb> T copy(Class<T> tagType)
                                throws TagTypeUnmatchException

return deep copy of myself

NOTICE: DO NOT USE clone() and copyTo() method ! They has bug. Use this copy() method instead of them.

 // usage
 Div div = html.getById(Div.class, "foo");
 Div div2 = div.copy(Div.class);
 

Parameters:

tagType -

Returns:

Throws:

TagTypeUnmatchException

copyNoException

public <T extends AbstractJaxb> T copyNoException(Class<T> tagType)

same as copy(Class) but never throw exception. return null if failed to copy.

Parameters:

tagType -

Returns:

setData

public void setData(String key,
                    String value)

set data-* attribute

 Div div = new Div();
 div.setData("foo", "bar");
 // you get <div data-foo="bar"></div>
 

Parameters:

key - data-"key"

getData

public String getData(String key)

return the value of data-* attribute. If not set, return null.

Parameters:

key - data-"key"

Returns:

null if not found attribute

setAria

public void setAria(String key,
                    String value)

set area-* attribute

Parameters:

key - aria-"key"

value -

getAria

public String getAria(String key)

return the value of area-* attribute. If not set, return null.

Parameters:

key - aria-"key"

Returns:

removeData

public String removeData(String key)

remove a specified data-* attribute.

Parameters:

key - data-"key"

Returns:

the previous value associated with key, or null if there was no mapping for key.

removeAria

public String removeAria(String key)

remove a specified aria-* attribute.

Parameters:

key - data-"key"

Returns:

the previous value associated with key, or null if there was no mapping for key.

getOtherAttributes

public Map<QName,String> getOtherAttributes()

get other attribute map. NOTICE: this method is dummy for make coding easy. Acrually, this method is overridden by each tag class.

Returns:

getId

public String getId()

get id attribute. return null if not set. NOTICE: this method is dummy for make coding easy. Acrually, this method is overridden by each tag class.

Returns:

setId

public void setId(String id)

set id attribute. NOTICE: this method is dummy for make coding easy. Acrually, this method is overridden by each tag class.

isSetId

public boolean isSetId()

NOTICE: this method is dummy for make coding easy. Acrually, this method is overridden by each tag class.

unsetAllId

public void unsetAllId()

remove id attribute of all descendant elements. Also, remove id attribute of myself.

unsetAllId

public void unsetAllId(Pattern pattern)

remove id attribute that matches specified regex. Also, matches and remove of myself.

getStyle

public String getStyle()

NOTICE: this method is dummy for make coding easy. Acrually, this method is overridden by each tag class.

Returns:

setStyle

public void setStyle(String value)

NOTICE: this method is dummy for make coding easy. Acrually, this method is overridden by each tag class.

Parameters:

value -

getCssClass

public List<String> getCssClass()

return class attribute as List. NOTICE: this method is dummy for make coding easy. Acrually, this method is overridden by each tag class.

Returns:

hasCssClass

public <T extends AbstractJaxb> boolean hasCssClass(String clazz)

return true if have specified class attribute.

Parameters:

clazz - class attribute

Returns:

addCssClass

public <T extends AbstractJaxb> void addCssClass(String clazz)

add class attribute. If already set, do nothing.

removeCssClass

public <T extends AbstractJaxb> void removeCssClass(String clazz)

remove specified class attribute if having it.

removeEmptyCssClass

public void removeEmptyCssClass()

Remove class attribute if it has no value. This method prevent no-meaning class attribute like below.

 <div class="">....</div>
 

getByNameAsList

public <T extends AbstractJaxb> List<T> getByNameAsList(String name,
                                                        Class<T> tagType)

find tag by "name" property returning as List.

Type Parameters:

T -

Parameters:

name -

tagType -

Returns:

if not found, returns empty list.

getByName

public <T extends AbstractJaxb> T getByName(String name,
                                            Class<T> tagType)

find tag by "name" property. (the first one in this tag)

Type Parameters:

T -

Parameters:

name -

tagType -

Returns:

null if not found.

getHeaderAsList

public List<Header> getHeaderAsList()

get header tag

Returns:

getHeader

public Header getHeader()

get header tag (the first one in this tag)

Returns:

null if not found.

getFooterAsList

public List<Footer> getFooterAsList()

get footer tag

Returns:

getFooter

public Footer getFooter()

get footer tag (the first one in this tag)

Returns:

null if not found.

toByteArray

public byte[] toByteArray()
                   throws IOException

returns byte sequence of myself.

Returns:

Throws:

IOException

toString

public String toString()

FOR DEBUG. This method does not include the field of a null object in the returned string.

Overrides:

toString in class Object