Coverage Report

Coverage Report - yarfraw.core.datamodel.Text

Classes in this File

100%

 package yarfraw.core.datamodel;
 
 import java.io.IOException;
 import java.util.Locale;
 
 import javax.xml.parsers.ParserConfigurationException;
 
 import org.w3c.dom.Element;
 import org.xml.sax.SAXException;
 
 import yarfraw.utils.ValidationUtils;
 import yarfraw.utils.XMLUtils;
 
 /**
  * This class is mapped to element of type xs:string as well as to text constructs element in Atom 1.0.
  * <br/>
  * Only the text content is used for Rss 1.0 and Rss 2.0, all other fields are ignored. 
  * 
  * <br/>
  * for information about Atom 1.0, see http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html#rfc.section.4.1.2
  * 
  * @author jliang
  *
  */
 public class Text extends AbstractBaseObject{
   private static final long serialVersionUID = 20070927L;
   public enum TextType{
     text, html, xhtml
   }
   private TextType _type = TextType.text;
   private Element _xhtmlDiv;
   private String _text;
   
   public Text(){}
   
   /**
    * This constructs a {@link Text} of type 'text'
    */
   public Text(String text){
     _type = TextType.text;
     setText(text);
   }
   
   /**
    * The text content of this text element.
    * @return
    */
   public String getText() {
     return _text;
   }
 
   /**
    * 
    * @param text The text content of this text element.
    * @return this
    */
   public Text setText(String text) {
     _text = text;
     return this;
   }
 
 /**
  * <b>Atom 1.0 only </b> <br/>
  * The single xhtml div element if the text construct is an xhtml construct 
  */
   public Element getXhtmlDiv() {
     return _xhtmlDiv;
   }
   /**
    * <b>Atom 1.0 only </b> <br/>
    * The single xhtml div element if the text construct is an xhtml construct 
    */
   public Text setXhtmlDiv(Element xhtmlDiv) {
     _xhtmlDiv = xhtmlDiv;
     _type = TextType.xhtml;
     return this;
   }
   
   /**
    * <b>Atom 1.0 only </b> <br/>
    * The single xhtml div element if the text construct is an xhtml construct.
    * <br/>
    * This method parses the input xhtml string into an {@link Element} and put it 
    * to the xhtmlDiv field. Therefore it should be a single &lt;div> element.
    * 
    * @param xhtmlDiv any valid xhtml string
    * @return this
    * @throws SAXException
    * @throws IOException
    * @throws ParserConfigurationException
    */
   public Text setXhtmlDiv(String xhtmlDiv) throws SAXException, IOException, ParserConfigurationException {
     return setXhtmlDiv(XMLUtils.parseXml(xhtmlDiv, false, false).getDocumentElement());
   }
 
   /**
    * Type of the text. 
    * @param textType
    */
   public Text(TextType textType){
     setType(textType);
   }
   
   /**
    * Type of the text.
    * @return
    */
   public TextType getType() {
     return _type;
   }
   /**
    * Type of the text.
    * @return
    */
   public Text setType(TextType type) {
     _type = type;
     return this;
   }
 
 
   /**
    * <b>Atom 1.0 only</b><br/>
    * Any element defined by this specification MAY have an xml:base attribute 
    * [W3C.REC-xmlbase-20010627]. When xml:base is used in an Atom Document, 
    * it serves the function described in section 5.1.1 of [RFC3986], establishing 
    * the base URI (or IRI) for resolving any relative references found within the 
    * effective scope of the xml:base attribute.
    * @param base
    * @return
    */
   public Text setBase(String base) {
     _base = base;
     return this;
   }
   /**
    * <li>Rss 2.0 - &lt;language> element. 
    * The language the channel is written in. This allows aggregators to group 
    * all Italian language sites, for example, on a single page. A list of allowable 
    * values for this element, as provided by Netscape, is here. You may also use values 
    * defined by the W3C.
    * Only &lt;channel> support this element.</li>
    * <li>Rss 1.0 - &lt;dc:language> element. A language of the intellectual content of the resource.
    * Only &lt;channel> and &lt;item> support this element. </li>
    * <li>Atom 1.0 - 'lang' attribute</li>
    * <br/>
    * Note: for Rss 2.0 and Rss 1.0, only &lt;channel> and &lt;item>
    * @param lang
    * @return
    */
   public Text setLang(String lang) {
     _lang = lang;
     return this;
   }
   
   /**
    * <li>Rss 2.0 - &lt;language> element. 
    * The language the channel is written in. This allows aggregators to group 
    * all Italian language sites, for example, on a single page. A list of allowable 
    * values for this element, as provided by Netscape, is here. You may also use values 
    * defined by the W3C.
    * Only &lt;channel> support this element.</li>
    * <li>Rss 1.0 - &lt;dc:language> element. A language of the intellectual content of the resource.
    * Only &lt;channel> and &lt;item> support this element. </li>
    * <li>Atom 1.0 - 'lang' attribute</li>
    * <br/>
    * Note: for Rss 2.0 and Rss 1.0, only &lt;channel> and &lt;item>
    * @param lang
    * @return
    */
   public Text setLang(Locale lang) {
     _lang = lang.getLanguage();
     return this;
   }
   @Override
   public void validate(FeedFormat format) throws ValidationException {
     ValidationUtils.validateNotNull("Text value should not be null", _text);
   }
 }

1		package yarfraw.core.datamodel;
2
3		import java.io.IOException;
4		import java.util.Locale;
5
6		import javax.xml.parsers.ParserConfigurationException;
7
8		import org.w3c.dom.Element;
9		import org.xml.sax.SAXException;
10
11		import yarfraw.utils.ValidationUtils;
12		import yarfraw.utils.XMLUtils;
13
14		/**
15		* This class is mapped to element of type xs:string as well as to text constructs element in Atom 1.0.
16		* <br/>
17		* Only the text content is used for Rss 1.0 and Rss 2.0, all other fields are ignored.
18		*
19		* <br/>
20		* for information about Atom 1.0, see http://atompub.org/2005/07/11/draft-ietf-atompub-format-10.html#rfc.section.4.1.2
21		*
22		* @author jliang
23		*
24		*/
25	2279	public class Text extends AbstractBaseObject{
26		private static final long serialVersionUID = 20070927L;
27	312	public enum TextType{
28	78	text, html, xhtml
29		}
30	15350	private TextType _type = TextType.text;
31		private Element _xhtmlDiv;
32		private String _text;
33
34	1350	public Text(){}
35
36		/**
37		* This constructs a {@link Text} of type 'text'
38		*/
39	14672	public Text(String text){
40	14672	_type = TextType.text;
41	14672	setText(text);
42	14672	}
43
44		/**
45		* The text content of this text element.
46		* @return
47		*/
48		public String getText() {
49	3252	return _text;
50		}
51
52		/**
53		*
54		* @param text The text content of this text element.
55		* @return this
56		*/
57		public Text setText(String text) {
58	15347	_text = text;
59	15347	return this;
60		}
61
62		/**
63		* <b>Atom 1.0 only </b> <br/>
64		* The single xhtml div element if the text construct is an xhtml construct
65		*/
66		public Element getXhtmlDiv() {
67	216	return _xhtmlDiv;
68		}
69		/**
70		* <b>Atom 1.0 only </b> <br/>
71		* The single xhtml div element if the text construct is an xhtml construct
72		*/
73		public Text setXhtmlDiv(Element xhtmlDiv) {
74	3	_xhtmlDiv = xhtmlDiv;
75	3	_type = TextType.xhtml;
76	3	return this;
77		}
78
79		/**
80		* <b>Atom 1.0 only </b> <br/>
81		* The single xhtml div element if the text construct is an xhtml construct.
82		* <br/>
83		* This method parses the input xhtml string into an {@link Element} and put it
84		* to the xhtmlDiv field. Therefore it should be a single <div> element.
85		*
86		* @param xhtmlDiv any valid xhtml string
87		* @return this
88		* @throws SAXException
89		* @throws IOException
90		* @throws ParserConfigurationException
91		*/
92		public Text setXhtmlDiv(String xhtmlDiv) throws SAXException, IOException, ParserConfigurationException {
93	3	return setXhtmlDiv(XMLUtils.parseXml(xhtmlDiv, false, false).getDocumentElement());
94		}
95
96		/**
97		* Type of the text.
98		* @param textType
99		*/
100	3	public Text(TextType textType){
101	3	setType(textType);
102	3	}
103
104		/**
105		* Type of the text.
106		* @return
107		*/
108		public TextType getType() {
109	426	return _type;
110		}
111		/**
112		* Type of the text.
113		* @return
114		*/
115		public Text setType(TextType type) {
116	6	_type = type;
117	6	return this;
118		}
119
120
121		/**
122		* <b>Atom 1.0 only</b><br/>
123		* Any element defined by this specification MAY have an xml:base attribute
124		* [W3C.REC-xmlbase-20010627]. When xml:base is used in an Atom Document,
125		* it serves the function described in section 5.1.1 of [RFC3986], establishing
126		* the base URI (or IRI) for resolving any relative references found within the
127		* effective scope of the xml:base attribute.
128		* @param base
129		* @return
130		*/
131		public Text setBase(String base) {
132	675	_base = base;
133	675	return this;
134		}
135		/**
136		* <li>Rss 2.0 - <language> element.
137		* The language the channel is written in. This allows aggregators to group
138		* all Italian language sites, for example, on a single page. A list of allowable
139		* values for this element, as provided by Netscape, is here. You may also use values
140		* defined by the W3C.
141		* Only <channel> support this element.</li>
142		* <li>Rss 1.0 - <dc:language> element. A language of the intellectual content of the resource.
143		* Only <channel> and <item> support this element. </li>
144		* <li>Atom 1.0 - 'lang' attribute</li>
145		* <br/>
146		* Note: for Rss 2.0 and Rss 1.0, only <channel> and <item>
147		* @param lang
148		* @return
149		*/
150		public Text setLang(String lang) {
151	675	_lang = lang;
152	675	return this;
153		}
154
155		/**
156		* <li>Rss 2.0 - <language> element.
157		* The language the channel is written in. This allows aggregators to group
158		* all Italian language sites, for example, on a single page. A list of allowable
159		* values for this element, as provided by Netscape, is here. You may also use values
160		* defined by the W3C.
161		* Only <channel> support this element.</li>
162		* <li>Rss 1.0 - <dc:language> element. A language of the intellectual content of the resource.
163		* Only <channel> and <item> support this element. </li>
164		* <li>Atom 1.0 - 'lang' attribute</li>
165		* <br/>
166		* Note: for Rss 2.0 and Rss 1.0, only <channel> and <item>
167		* @param lang
168		* @return
169		*/
170		public Text setLang(Locale lang) {
171	3	_lang = lang.getLanguage();
172	3	return this;
173		}
174		@Override
175		public void validate(FeedFormat format) throws ValidationException {
176	18	ValidationUtils.validateNotNull("Text value should not be null", _text);
177	18	}
178		}