http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/src-html/org/apache/juneau/html/HtmlSerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlSerializerSession.html b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlSerializerSession.html index 4c7dbfb..bd1b6ce 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/html/HtmlSerializerSession.html +++ b/content/site/apidocs/src-html/org/apache/juneau/html/HtmlSerializerSession.html @@ -21,159 +21,175 @@ <span class="sourceLineNo">013</span>package org.apache.juneau.html;<a name="line.13"></a> <span class="sourceLineNo">014</span><a name="line.14"></a> <span class="sourceLineNo">015</span>import static org.apache.juneau.html.HtmlSerializerContext.*;<a name="line.15"></a> -<span class="sourceLineNo">016</span><a name="line.16"></a> -<span class="sourceLineNo">017</span>import java.lang.reflect.*;<a name="line.17"></a> -<span class="sourceLineNo">018</span>import java.util.*;<a name="line.18"></a> -<span class="sourceLineNo">019</span>import java.util.regex.*;<a name="line.19"></a> -<span class="sourceLineNo">020</span><a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.juneau.*;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.juneau.internal.*;<a name="line.22"></a> -<span class="sourceLineNo">023</span>import org.apache.juneau.json.*;<a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.juneau.xml.*;<a name="line.24"></a> -<span class="sourceLineNo">025</span><a name="line.25"></a> -<span class="sourceLineNo">026</span>/**<a name="line.26"></a> -<span class="sourceLineNo">027</span> * Session object that lives for the duration of a single use of {@link HtmlSerializer}.<a name="line.27"></a> -<span class="sourceLineNo">028</span> * <p><a name="line.28"></a> -<span class="sourceLineNo">029</span> * This class is NOT thread safe. It is meant to be discarded after one-time use.<a name="line.29"></a> -<span class="sourceLineNo">030</span> */<a name="line.30"></a> -<span class="sourceLineNo">031</span>public class HtmlSerializerSession extends XmlSerializerSession {<a name="line.31"></a> -<span class="sourceLineNo">032</span><a name="line.32"></a> -<span class="sourceLineNo">033</span> private final AnchorText anchorText;<a name="line.33"></a> -<span class="sourceLineNo">034</span> private final boolean detectLinksInStrings, lookForLabelParameters, addKeyValueTableHeaders;<a name="line.34"></a> -<span class="sourceLineNo">035</span> private final Pattern urlPattern = Pattern.compile("http[s]?\\:\\/\\/.*");<a name="line.35"></a> -<span class="sourceLineNo">036</span> private final Pattern labelPattern;<a name="line.36"></a> -<span class="sourceLineNo">037</span> private final String absolutePathUriBase, relativeUriBase;<a name="line.37"></a> -<span class="sourceLineNo">038</span><a name="line.38"></a> -<span class="sourceLineNo">039</span><a name="line.39"></a> -<span class="sourceLineNo">040</span> @SuppressWarnings("hiding")<a name="line.40"></a> -<span class="sourceLineNo">041</span> enum AnchorText {<a name="line.41"></a> -<span class="sourceLineNo">042</span> PROPERTY_NAME, TO_STRING, URI, LAST_TOKEN, URI_ANCHOR<a name="line.42"></a> -<span class="sourceLineNo">043</span> }<a name="line.43"></a> +<span class="sourceLineNo">016</span>import static org.apache.juneau.msgpack.MsgPackSerializerContext.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span><a name="line.17"></a> +<span class="sourceLineNo">018</span>import java.lang.reflect.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import java.util.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import java.util.regex.*;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.juneau.*;<a name="line.22"></a> +<span class="sourceLineNo">023</span>import org.apache.juneau.internal.*;<a name="line.23"></a> +<span class="sourceLineNo">024</span>import org.apache.juneau.json.*;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.juneau.xml.*;<a name="line.25"></a> +<span class="sourceLineNo">026</span><a name="line.26"></a> +<span class="sourceLineNo">027</span>/**<a name="line.27"></a> +<span class="sourceLineNo">028</span> * Session object that lives for the duration of a single use of {@link HtmlSerializer}.<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <p><a name="line.29"></a> +<span class="sourceLineNo">030</span> * This class is NOT thread safe. It is meant to be discarded after one-time use.<a name="line.30"></a> +<span class="sourceLineNo">031</span> */<a name="line.31"></a> +<span class="sourceLineNo">032</span>public class HtmlSerializerSession extends XmlSerializerSession {<a name="line.32"></a> +<span class="sourceLineNo">033</span><a name="line.33"></a> +<span class="sourceLineNo">034</span> private final AnchorText anchorText;<a name="line.34"></a> +<span class="sourceLineNo">035</span> private final boolean<a name="line.35"></a> +<span class="sourceLineNo">036</span> detectLinksInStrings,<a name="line.36"></a> +<span class="sourceLineNo">037</span> lookForLabelParameters,<a name="line.37"></a> +<span class="sourceLineNo">038</span> addKeyValueTableHeaders,<a name="line.38"></a> +<span class="sourceLineNo">039</span> addBeanTypeProperties;<a name="line.39"></a> +<span class="sourceLineNo">040</span> private final Pattern urlPattern = Pattern.compile("http[s]?\\:\\/\\/.*");<a name="line.40"></a> +<span class="sourceLineNo">041</span> private final Pattern labelPattern;<a name="line.41"></a> +<span class="sourceLineNo">042</span> private final String absolutePathUriBase, relativeUriBase;<a name="line.42"></a> +<span class="sourceLineNo">043</span><a name="line.43"></a> <span class="sourceLineNo">044</span><a name="line.44"></a> -<span class="sourceLineNo">045</span> /**<a name="line.45"></a> -<span class="sourceLineNo">046</span> * Create a new session using properties specified in the context.<a name="line.46"></a> -<span class="sourceLineNo">047</span> *<a name="line.47"></a> -<span class="sourceLineNo">048</span> * @param ctx The context creating this session object.<a name="line.48"></a> -<span class="sourceLineNo">049</span> * The context contains all the configuration settings for this object.<a name="line.49"></a> -<span class="sourceLineNo">050</span> * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.<a name="line.50"></a> -<span class="sourceLineNo">051</span> * @param op The override properties.<a name="line.51"></a> -<span class="sourceLineNo">052</span> * These override any context properties defined in the context.<a name="line.52"></a> -<span class="sourceLineNo">053</span> * @param javaMethod The java method that called this parser, usually the method in a REST servlet.<a name="line.53"></a> -<span class="sourceLineNo">054</span> * @param locale The session locale.<a name="line.54"></a> -<span class="sourceLineNo">055</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.55"></a> -<span class="sourceLineNo">056</span> * @param timeZone The session timezone.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.57"></a> -<span class="sourceLineNo">058</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.58"></a> -<span class="sourceLineNo">059</span> */<a name="line.59"></a> -<span class="sourceLineNo">060</span> protected HtmlSerializerSession(HtmlSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.60"></a> -<span class="sourceLineNo">061</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType);<a name="line.61"></a> -<span class="sourceLineNo">062</span> String labelParameter;<a name="line.62"></a> -<span class="sourceLineNo">063</span> if (op == null || op.isEmpty()) {<a name="line.63"></a> -<span class="sourceLineNo">064</span> anchorText = Enum.valueOf(AnchorText.class, ctx.uriAnchorText);<a name="line.64"></a> -<span class="sourceLineNo">065</span> detectLinksInStrings = ctx.detectLinksInStrings;<a name="line.65"></a> -<span class="sourceLineNo">066</span> lookForLabelParameters = ctx.lookForLabelParameters;<a name="line.66"></a> -<span class="sourceLineNo">067</span> labelParameter = ctx.labelParameter;<a name="line.67"></a> -<span class="sourceLineNo">068</span> addKeyValueTableHeaders = ctx.addKeyValueTableHeaders;<a name="line.68"></a> -<span class="sourceLineNo">069</span> } else {<a name="line.69"></a> -<span class="sourceLineNo">070</span> anchorText = Enum.valueOf(AnchorText.class, op.getString(HTML_uriAnchorText, ctx.uriAnchorText));<a name="line.70"></a> -<span class="sourceLineNo">071</span> detectLinksInStrings = op.getBoolean(HTML_detectLinksInStrings, ctx.detectLinksInStrings);<a name="line.71"></a> -<span class="sourceLineNo">072</span> lookForLabelParameters = op.getBoolean(HTML_lookForLabelParameters, ctx.lookForLabelParameters);<a name="line.72"></a> -<span class="sourceLineNo">073</span> labelParameter = op.getString(HTML_labelParameter, ctx.labelParameter);<a name="line.73"></a> -<span class="sourceLineNo">074</span> addKeyValueTableHeaders = op.getBoolean(HTML_addKeyValueTableHeaders, ctx.addKeyValueTableHeaders);<a name="line.74"></a> -<span class="sourceLineNo">075</span> }<a name="line.75"></a> -<span class="sourceLineNo">076</span> labelPattern = Pattern.compile("[\\?\\&]" + Pattern.quote(labelParameter) + "=([^\\&]*)");<a name="line.76"></a> -<span class="sourceLineNo">077</span> this.absolutePathUriBase = getAbsolutePathUriBase();<a name="line.77"></a> -<span class="sourceLineNo">078</span> this.relativeUriBase = getRelativeUriBase();<a name="line.78"></a> -<span class="sourceLineNo">079</span> }<a name="line.79"></a> -<span class="sourceLineNo">080</span><a name="line.80"></a> -<span class="sourceLineNo">081</span> @Override /* XmlSerializerSession */<a name="line.81"></a> -<span class="sourceLineNo">082</span> public HtmlWriter getWriter() throws Exception {<a name="line.82"></a> -<span class="sourceLineNo">083</span> Object output = getOutput();<a name="line.83"></a> -<span class="sourceLineNo">084</span> if (output instanceof HtmlWriter)<a name="line.84"></a> -<span class="sourceLineNo">085</span> return (HtmlWriter)output;<a name="line.85"></a> -<span class="sourceLineNo">086</span> return new HtmlWriter(super.getWriter(), isUseWhitespace(), isTrimStrings(), getQuoteChar(), getRelativeUriBase(), getAbsolutePathUriBase());<a name="line.86"></a> -<span class="sourceLineNo">087</span> }<a name="line.87"></a> -<span class="sourceLineNo">088</span><a name="line.88"></a> -<span class="sourceLineNo">089</span> /**<a name="line.89"></a> -<span class="sourceLineNo">090</span> * Returns <jk>true</jk> if the specified object is a URL.<a name="line.90"></a> -<span class="sourceLineNo">091</span> *<a name="line.91"></a> -<span class="sourceLineNo">092</span> * @param cm The ClassMeta of the object being serialized.<a name="line.92"></a> -<span class="sourceLineNo">093</span> * @param pMeta The property metadata of the bean property of the object. Can be <jk>null</jk> if the object isn't from a bean property.<a name="line.93"></a> -<span class="sourceLineNo">094</span> * @param o The object.<a name="line.94"></a> -<span class="sourceLineNo">095</span> * @return <jk>true</jk> if the specified object is a URL.<a name="line.95"></a> -<span class="sourceLineNo">096</span> */<a name="line.96"></a> -<span class="sourceLineNo">097</span> public boolean isUri(ClassMeta<?> cm, BeanPropertyMeta pMeta, Object o) {<a name="line.97"></a> -<span class="sourceLineNo">098</span> if (cm.isUri())<a name="line.98"></a> -<span class="sourceLineNo">099</span> return true;<a name="line.99"></a> -<span class="sourceLineNo">100</span> if (pMeta != null && pMeta.isUri())<a name="line.100"></a> -<span class="sourceLineNo">101</span> return true;<a name="line.101"></a> -<span class="sourceLineNo">102</span> if (detectLinksInStrings && o instanceof CharSequence && urlPattern.matcher(o.toString()).matches())<a name="line.102"></a> -<span class="sourceLineNo">103</span> return true;<a name="line.103"></a> -<span class="sourceLineNo">104</span> return false;<a name="line.104"></a> -<span class="sourceLineNo">105</span> }<a name="line.105"></a> -<span class="sourceLineNo">106</span><a name="line.106"></a> -<span class="sourceLineNo">107</span> /**<a name="line.107"></a> -<span class="sourceLineNo">108</span> * Returns the anchor text to use for the specified URL object.<a name="line.108"></a> -<span class="sourceLineNo">109</span> *<a name="line.109"></a> -<span class="sourceLineNo">110</span> * @param pMeta The property metadata of the bean property of the object. Can be <jk>null</jk> if the object isn't from a bean property.<a name="line.110"></a> -<span class="sourceLineNo">111</span> * @param o The URL object.<a name="line.111"></a> -<span class="sourceLineNo">112</span> * @return The anchor text to use for the specified URL object.<a name="line.112"></a> -<span class="sourceLineNo">113</span> */<a name="line.113"></a> -<span class="sourceLineNo">114</span> public String getAnchorText(BeanPropertyMeta pMeta, Object o) {<a name="line.114"></a> -<span class="sourceLineNo">115</span> String s;<a name="line.115"></a> -<span class="sourceLineNo">116</span> if (lookForLabelParameters) {<a name="line.116"></a> -<span class="sourceLineNo">117</span> s = o.toString();<a name="line.117"></a> -<span class="sourceLineNo">118</span> Matcher m = labelPattern.matcher(s);<a name="line.118"></a> -<span class="sourceLineNo">119</span> if (m.find())<a name="line.119"></a> -<span class="sourceLineNo">120</span> return m.group(1);<a name="line.120"></a> -<span class="sourceLineNo">121</span> }<a name="line.121"></a> -<span class="sourceLineNo">122</span> switch (anchorText) {<a name="line.122"></a> -<span class="sourceLineNo">123</span> case LAST_TOKEN:<a name="line.123"></a> -<span class="sourceLineNo">124</span> s = o.toString();<a name="line.124"></a> -<span class="sourceLineNo">125</span> if (s.indexOf('/') != -1)<a name="line.125"></a> -<span class="sourceLineNo">126</span> s = s.substring(s.lastIndexOf('/')+1);<a name="line.126"></a> -<span class="sourceLineNo">127</span> if (s.indexOf('?') != -1)<a name="line.127"></a> -<span class="sourceLineNo">128</span> s = s.substring(0, s.indexOf('?'));<a name="line.128"></a> -<span class="sourceLineNo">129</span> if (s.indexOf('#') != -1)<a name="line.129"></a> -<span class="sourceLineNo">130</span> s = s.substring(0, s.indexOf('#'));<a name="line.130"></a> -<span class="sourceLineNo">131</span> return s;<a name="line.131"></a> -<span class="sourceLineNo">132</span> case URI_ANCHOR:<a name="line.132"></a> -<span class="sourceLineNo">133</span> s = o.toString();<a name="line.133"></a> -<span class="sourceLineNo">134</span> if (s.indexOf('#') != -1)<a name="line.134"></a> -<span class="sourceLineNo">135</span> s = s.substring(s.lastIndexOf('#')+1);<a name="line.135"></a> -<span class="sourceLineNo">136</span> return s;<a name="line.136"></a> -<span class="sourceLineNo">137</span> case PROPERTY_NAME:<a name="line.137"></a> -<span class="sourceLineNo">138</span> return pMeta == null ? o.toString() : pMeta.getName();<a name="line.138"></a> -<span class="sourceLineNo">139</span> case URI:<a name="line.139"></a> +<span class="sourceLineNo">045</span> @SuppressWarnings("hiding")<a name="line.45"></a> +<span class="sourceLineNo">046</span> enum AnchorText {<a name="line.46"></a> +<span class="sourceLineNo">047</span> PROPERTY_NAME, TO_STRING, URI, LAST_TOKEN, URI_ANCHOR<a name="line.47"></a> +<span class="sourceLineNo">048</span> }<a name="line.48"></a> +<span class="sourceLineNo">049</span><a name="line.49"></a> +<span class="sourceLineNo">050</span> /**<a name="line.50"></a> +<span class="sourceLineNo">051</span> * Create a new session using properties specified in the context.<a name="line.51"></a> +<span class="sourceLineNo">052</span> *<a name="line.52"></a> +<span class="sourceLineNo">053</span> * @param ctx The context creating this session object.<a name="line.53"></a> +<span class="sourceLineNo">054</span> * The context contains all the configuration settings for this object.<a name="line.54"></a> +<span class="sourceLineNo">055</span> * @param output The output object. See {@link JsonSerializerSession#getWriter()} for valid class types.<a name="line.55"></a> +<span class="sourceLineNo">056</span> * @param op The override properties.<a name="line.56"></a> +<span class="sourceLineNo">057</span> * These override any context properties defined in the context.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * @param javaMethod The java method that called this parser, usually the method in a REST servlet.<a name="line.58"></a> +<span class="sourceLineNo">059</span> * @param locale The session locale.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * If <jk>null</jk>, then the locale defined on the context is used.<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @param timeZone The session timezone.<a name="line.61"></a> +<span class="sourceLineNo">062</span> * If <jk>null</jk>, then the timezone defined on the context is used.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @param mediaType The session media type (e.g. <js>"application/json"</js>).<a name="line.63"></a> +<span class="sourceLineNo">064</span> */<a name="line.64"></a> +<span class="sourceLineNo">065</span> protected HtmlSerializerSession(HtmlSerializerContext ctx, ObjectMap op, Object output, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType) {<a name="line.65"></a> +<span class="sourceLineNo">066</span> super(ctx, op, output, javaMethod, locale, timeZone, mediaType);<a name="line.66"></a> +<span class="sourceLineNo">067</span> String labelParameter;<a name="line.67"></a> +<span class="sourceLineNo">068</span> if (op == null || op.isEmpty()) {<a name="line.68"></a> +<span class="sourceLineNo">069</span> anchorText = Enum.valueOf(AnchorText.class, ctx.uriAnchorText);<a name="line.69"></a> +<span class="sourceLineNo">070</span> detectLinksInStrings = ctx.detectLinksInStrings;<a name="line.70"></a> +<span class="sourceLineNo">071</span> lookForLabelParameters = ctx.lookForLabelParameters;<a name="line.71"></a> +<span class="sourceLineNo">072</span> labelParameter = ctx.labelParameter;<a name="line.72"></a> +<span class="sourceLineNo">073</span> addKeyValueTableHeaders = ctx.addKeyValueTableHeaders;<a name="line.73"></a> +<span class="sourceLineNo">074</span> addBeanTypeProperties = ctx.addBeanTypeProperties;<a name="line.74"></a> +<span class="sourceLineNo">075</span> } else {<a name="line.75"></a> +<span class="sourceLineNo">076</span> anchorText = Enum.valueOf(AnchorText.class, op.getString(HTML_uriAnchorText, ctx.uriAnchorText));<a name="line.76"></a> +<span class="sourceLineNo">077</span> detectLinksInStrings = op.getBoolean(HTML_detectLinksInStrings, ctx.detectLinksInStrings);<a name="line.77"></a> +<span class="sourceLineNo">078</span> lookForLabelParameters = op.getBoolean(HTML_lookForLabelParameters, ctx.lookForLabelParameters);<a name="line.78"></a> +<span class="sourceLineNo">079</span> labelParameter = op.getString(HTML_labelParameter, ctx.labelParameter);<a name="line.79"></a> +<span class="sourceLineNo">080</span> addKeyValueTableHeaders = op.getBoolean(HTML_addKeyValueTableHeaders, ctx.addKeyValueTableHeaders);<a name="line.80"></a> +<span class="sourceLineNo">081</span> addBeanTypeProperties = op.getBoolean(MSGPACK_addBeanTypeProperties, ctx.addBeanTypeProperties);<a name="line.81"></a> +<span class="sourceLineNo">082</span> }<a name="line.82"></a> +<span class="sourceLineNo">083</span> labelPattern = Pattern.compile("[\\?\\&]" + Pattern.quote(labelParameter) + "=([^\\&]*)");<a name="line.83"></a> +<span class="sourceLineNo">084</span> this.absolutePathUriBase = getAbsolutePathUriBase();<a name="line.84"></a> +<span class="sourceLineNo">085</span> this.relativeUriBase = getRelativeUriBase();<a name="line.85"></a> +<span class="sourceLineNo">086</span> }<a name="line.86"></a> +<span class="sourceLineNo">087</span><a name="line.87"></a> +<span class="sourceLineNo">088</span> @Override /* XmlSerializerSession */<a name="line.88"></a> +<span class="sourceLineNo">089</span> public HtmlWriter getWriter() throws Exception {<a name="line.89"></a> +<span class="sourceLineNo">090</span> Object output = getOutput();<a name="line.90"></a> +<span class="sourceLineNo">091</span> if (output instanceof HtmlWriter)<a name="line.91"></a> +<span class="sourceLineNo">092</span> return (HtmlWriter)output;<a name="line.92"></a> +<span class="sourceLineNo">093</span> return new HtmlWriter(super.getWriter(), isUseWhitespace(), isTrimStrings(), getQuoteChar(), getRelativeUriBase(), getAbsolutePathUriBase());<a name="line.93"></a> +<span class="sourceLineNo">094</span> }<a name="line.94"></a> +<span class="sourceLineNo">095</span><a name="line.95"></a> +<span class="sourceLineNo">096</span> /**<a name="line.96"></a> +<span class="sourceLineNo">097</span> * Returns <jk>true</jk> if the specified object is a URL.<a name="line.97"></a> +<span class="sourceLineNo">098</span> *<a name="line.98"></a> +<span class="sourceLineNo">099</span> * @param cm The ClassMeta of the object being serialized.<a name="line.99"></a> +<span class="sourceLineNo">100</span> * @param pMeta The property metadata of the bean property of the object. Can be <jk>null</jk> if the object isn't from a bean property.<a name="line.100"></a> +<span class="sourceLineNo">101</span> * @param o The object.<a name="line.101"></a> +<span class="sourceLineNo">102</span> * @return <jk>true</jk> if the specified object is a URL.<a name="line.102"></a> +<span class="sourceLineNo">103</span> */<a name="line.103"></a> +<span class="sourceLineNo">104</span> public boolean isUri(ClassMeta<?> cm, BeanPropertyMeta pMeta, Object o) {<a name="line.104"></a> +<span class="sourceLineNo">105</span> if (cm.isUri())<a name="line.105"></a> +<span class="sourceLineNo">106</span> return true;<a name="line.106"></a> +<span class="sourceLineNo">107</span> if (pMeta != null && pMeta.isUri())<a name="line.107"></a> +<span class="sourceLineNo">108</span> return true;<a name="line.108"></a> +<span class="sourceLineNo">109</span> if (detectLinksInStrings && o instanceof CharSequence && urlPattern.matcher(o.toString()).matches())<a name="line.109"></a> +<span class="sourceLineNo">110</span> return true;<a name="line.110"></a> +<span class="sourceLineNo">111</span> return false;<a name="line.111"></a> +<span class="sourceLineNo">112</span> }<a name="line.112"></a> +<span class="sourceLineNo">113</span><a name="line.113"></a> +<span class="sourceLineNo">114</span> /**<a name="line.114"></a> +<span class="sourceLineNo">115</span> * Returns the anchor text to use for the specified URL object.<a name="line.115"></a> +<span class="sourceLineNo">116</span> *<a name="line.116"></a> +<span class="sourceLineNo">117</span> * @param pMeta The property metadata of the bean property of the object. Can be <jk>null</jk> if the object isn't from a bean property.<a name="line.117"></a> +<span class="sourceLineNo">118</span> * @param o The URL object.<a name="line.118"></a> +<span class="sourceLineNo">119</span> * @return The anchor text to use for the specified URL object.<a name="line.119"></a> +<span class="sourceLineNo">120</span> */<a name="line.120"></a> +<span class="sourceLineNo">121</span> public String getAnchorText(BeanPropertyMeta pMeta, Object o) {<a name="line.121"></a> +<span class="sourceLineNo">122</span> String s;<a name="line.122"></a> +<span class="sourceLineNo">123</span> if (lookForLabelParameters) {<a name="line.123"></a> +<span class="sourceLineNo">124</span> s = o.toString();<a name="line.124"></a> +<span class="sourceLineNo">125</span> Matcher m = labelPattern.matcher(s);<a name="line.125"></a> +<span class="sourceLineNo">126</span> if (m.find())<a name="line.126"></a> +<span class="sourceLineNo">127</span> return m.group(1);<a name="line.127"></a> +<span class="sourceLineNo">128</span> }<a name="line.128"></a> +<span class="sourceLineNo">129</span> switch (anchorText) {<a name="line.129"></a> +<span class="sourceLineNo">130</span> case LAST_TOKEN:<a name="line.130"></a> +<span class="sourceLineNo">131</span> s = o.toString();<a name="line.131"></a> +<span class="sourceLineNo">132</span> if (s.indexOf('/') != -1)<a name="line.132"></a> +<span class="sourceLineNo">133</span> s = s.substring(s.lastIndexOf('/')+1);<a name="line.133"></a> +<span class="sourceLineNo">134</span> if (s.indexOf('?') != -1)<a name="line.134"></a> +<span class="sourceLineNo">135</span> s = s.substring(0, s.indexOf('?'));<a name="line.135"></a> +<span class="sourceLineNo">136</span> if (s.indexOf('#') != -1)<a name="line.136"></a> +<span class="sourceLineNo">137</span> s = s.substring(0, s.indexOf('#'));<a name="line.137"></a> +<span class="sourceLineNo">138</span> return s;<a name="line.138"></a> +<span class="sourceLineNo">139</span> case URI_ANCHOR:<a name="line.139"></a> <span class="sourceLineNo">140</span> s = o.toString();<a name="line.140"></a> -<span class="sourceLineNo">141</span> if (s.indexOf("://") == -1) {<a name="line.141"></a> -<span class="sourceLineNo">142</span> if (StringUtils.startsWith(s, '/')) {<a name="line.142"></a> -<span class="sourceLineNo">143</span> s = absolutePathUriBase + s;<a name="line.143"></a> -<span class="sourceLineNo">144</span> } else {<a name="line.144"></a> -<span class="sourceLineNo">145</span> if (relativeUriBase != null) {<a name="line.145"></a> -<span class="sourceLineNo">146</span> if (! relativeUriBase.equals("/"))<a name="line.146"></a> -<span class="sourceLineNo">147</span> s = relativeUriBase + "/" + s;<a name="line.147"></a> -<span class="sourceLineNo">148</span> else<a name="line.148"></a> -<span class="sourceLineNo">149</span> s = "/" + s;<a name="line.149"></a> -<span class="sourceLineNo">150</span> }<a name="line.150"></a> -<span class="sourceLineNo">151</span> }<a name="line.151"></a> -<span class="sourceLineNo">152</span> }<a name="line.152"></a> -<span class="sourceLineNo">153</span> return s;<a name="line.153"></a> -<span class="sourceLineNo">154</span> default:<a name="line.154"></a> -<span class="sourceLineNo">155</span> return o.toString();<a name="line.155"></a> -<span class="sourceLineNo">156</span> }<a name="line.156"></a> -<span class="sourceLineNo">157</span> }<a name="line.157"></a> -<span class="sourceLineNo">158</span><a name="line.158"></a> -<span class="sourceLineNo">159</span> /**<a name="line.159"></a> -<span class="sourceLineNo">160</span> * Returns the {@link HtmlSerializerContext#HTML_addKeyValueTableHeaders} setting value for this session.<a name="line.160"></a> -<span class="sourceLineNo">161</span> *<a name="line.161"></a> -<span class="sourceLineNo">162</span> * @return The {@link HtmlSerializerContext#HTML_addKeyValueTableHeaders} setting value for this session.<a name="line.162"></a> -<span class="sourceLineNo">163</span> */<a name="line.163"></a> -<span class="sourceLineNo">164</span> public final boolean isAddKeyValueTableHeaders() {<a name="line.164"></a> -<span class="sourceLineNo">165</span> return addKeyValueTableHeaders;<a name="line.165"></a> -<span class="sourceLineNo">166</span> }<a name="line.166"></a> -<span class="sourceLineNo">167</span><a name="line.167"></a> -<span class="sourceLineNo">168</span>}<a name="line.168"></a> +<span class="sourceLineNo">141</span> if (s.indexOf('#') != -1)<a name="line.141"></a> +<span class="sourceLineNo">142</span> s = s.substring(s.lastIndexOf('#')+1);<a name="line.142"></a> +<span class="sourceLineNo">143</span> return s;<a name="line.143"></a> +<span class="sourceLineNo">144</span> case PROPERTY_NAME:<a name="line.144"></a> +<span class="sourceLineNo">145</span> return pMeta == null ? o.toString() : pMeta.getName();<a name="line.145"></a> +<span class="sourceLineNo">146</span> case URI:<a name="line.146"></a> +<span class="sourceLineNo">147</span> s = o.toString();<a name="line.147"></a> +<span class="sourceLineNo">148</span> if (s.indexOf("://") == -1) {<a name="line.148"></a> +<span class="sourceLineNo">149</span> if (StringUtils.startsWith(s, '/')) {<a name="line.149"></a> +<span class="sourceLineNo">150</span> s = absolutePathUriBase + s;<a name="line.150"></a> +<span class="sourceLineNo">151</span> } else {<a name="line.151"></a> +<span class="sourceLineNo">152</span> if (relativeUriBase != null) {<a name="line.152"></a> +<span class="sourceLineNo">153</span> if (! relativeUriBase.equals("/"))<a name="line.153"></a> +<span class="sourceLineNo">154</span> s = relativeUriBase + "/" + s;<a name="line.154"></a> +<span class="sourceLineNo">155</span> else<a name="line.155"></a> +<span class="sourceLineNo">156</span> s = "/" + s;<a name="line.156"></a> +<span class="sourceLineNo">157</span> }<a name="line.157"></a> +<span class="sourceLineNo">158</span> }<a name="line.158"></a> +<span class="sourceLineNo">159</span> }<a name="line.159"></a> +<span class="sourceLineNo">160</span> return s;<a name="line.160"></a> +<span class="sourceLineNo">161</span> default:<a name="line.161"></a> +<span class="sourceLineNo">162</span> return o.toString();<a name="line.162"></a> +<span class="sourceLineNo">163</span> }<a name="line.163"></a> +<span class="sourceLineNo">164</span> }<a name="line.164"></a> +<span class="sourceLineNo">165</span><a name="line.165"></a> +<span class="sourceLineNo">166</span> /**<a name="line.166"></a> +<span class="sourceLineNo">167</span> * Returns the {@link HtmlSerializerContext#HTML_addKeyValueTableHeaders} setting value for this session.<a name="line.167"></a> +<span class="sourceLineNo">168</span> *<a name="line.168"></a> +<span class="sourceLineNo">169</span> * @return The {@link HtmlSerializerContext#HTML_addKeyValueTableHeaders} setting value for this session.<a name="line.169"></a> +<span class="sourceLineNo">170</span> */<a name="line.170"></a> +<span class="sourceLineNo">171</span> public final boolean isAddKeyValueTableHeaders() {<a name="line.171"></a> +<span class="sourceLineNo">172</span> return addKeyValueTableHeaders;<a name="line.172"></a> +<span class="sourceLineNo">173</span> }<a name="line.173"></a> +<span class="sourceLineNo">174</span><a name="line.174"></a> +<span class="sourceLineNo">175</span> /**<a name="line.175"></a> +<span class="sourceLineNo">176</span> * Returns the {@link HtmlSerializerContext#HTML_addBeanTypeProperties} setting value for this session.<a name="line.176"></a> +<span class="sourceLineNo">177</span> *<a name="line.177"></a> +<span class="sourceLineNo">178</span> * @return The {@link HtmlSerializerContext#HTML_addBeanTypeProperties} setting value for this session.<a name="line.178"></a> +<span class="sourceLineNo">179</span> */<a name="line.179"></a> +<span class="sourceLineNo">180</span> @Override /* SerializerSession */<a name="line.180"></a> +<span class="sourceLineNo">181</span> public final boolean isAddBeanTypeProperties() {<a name="line.181"></a> +<span class="sourceLineNo">182</span> return addBeanTypeProperties;<a name="line.182"></a> +<span class="sourceLineNo">183</span> }<a name="line.183"></a> +<span class="sourceLineNo">184</span>}<a name="line.184"></a>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/src-html/org/apache/juneau/jena/RdfSerializerContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/jena/RdfSerializerContext.html b/content/site/apidocs/src-html/org/apache/juneau/jena/RdfSerializerContext.html index d225978..19667da 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/jena/RdfSerializerContext.html +++ b/content/site/apidocs/src-html/org/apache/juneau/jena/RdfSerializerContext.html @@ -111,53 +111,80 @@ <span class="sourceLineNo">103</span> */<a name="line.103"></a> <span class="sourceLineNo">104</span> public static final String RDF_namespaces = "RdfSerializer.namespaces.list";<a name="line.104"></a> <span class="sourceLineNo">105</span><a name="line.105"></a> -<span class="sourceLineNo">106</span><a name="line.106"></a> -<span class="sourceLineNo">107</span> final boolean addLiteralTypes, addRootProperty, useXmlNamespaces, looseCollections, autoDetectNamespaces;<a name="line.107"></a> -<span class="sourceLineNo">108</span> final String rdfLanguage;<a name="line.108"></a> -<span class="sourceLineNo">109</span> final Namespace juneauNs;<a name="line.109"></a> -<span class="sourceLineNo">110</span> final Namespace juneauBpNs;<a name="line.110"></a> -<span class="sourceLineNo">111</span> final RdfCollectionFormat collectionFormat;<a name="line.111"></a> -<span class="sourceLineNo">112</span> final Map<String,Object> jenaSettings = new HashMap<String,Object>();<a name="line.112"></a> -<span class="sourceLineNo">113</span> final Namespace[] namespaces;<a name="line.113"></a> -<span class="sourceLineNo">114</span><a name="line.114"></a> -<span class="sourceLineNo">115</span> /**<a name="line.115"></a> -<span class="sourceLineNo">116</span> * Constructor.<a name="line.116"></a> -<span class="sourceLineNo">117</span> * <p><a name="line.117"></a> -<span class="sourceLineNo">118</span> * Typically only called from {@link ContextFactory#getContext(Class)}.<a name="line.118"></a> -<span class="sourceLineNo">119</span> *<a name="line.119"></a> -<span class="sourceLineNo">120</span> * @param cf The factory that created this context.<a name="line.120"></a> -<span class="sourceLineNo">121</span> */<a name="line.121"></a> -<span class="sourceLineNo">122</span> public RdfSerializerContext(ContextFactory cf) {<a name="line.122"></a> -<span class="sourceLineNo">123</span> super(cf);<a name="line.123"></a> -<span class="sourceLineNo">124</span> addLiteralTypes = cf.getProperty(RDF_addLiteralTypes, boolean.class, false);<a name="line.124"></a> -<span class="sourceLineNo">125</span> addRootProperty = cf.getProperty(RDF_addRootProperty, boolean.class, false);<a name="line.125"></a> -<span class="sourceLineNo">126</span> useXmlNamespaces = cf.getProperty(RDF_useXmlNamespaces, boolean.class, true);<a name="line.126"></a> -<span class="sourceLineNo">127</span> looseCollections = cf.getProperty(RDF_looseCollections, boolean.class, false);<a name="line.127"></a> -<span class="sourceLineNo">128</span> autoDetectNamespaces = cf.getProperty(RDF_autoDetectNamespaces, boolean.class, true);<a name="line.128"></a> -<span class="sourceLineNo">129</span> rdfLanguage = cf.getProperty(RDF_language, String.class, "RDF/XML-ABBREV");<a name="line.129"></a> -<span class="sourceLineNo">130</span> juneauNs = cf.getProperty(RDF_juneauNs, Namespace.class, new Namespace("j", "http://www.apache.org/juneau/";));<a name="line.130"></a> -<span class="sourceLineNo">131</span> juneauBpNs = cf.getProperty(RDF_juneauBpNs, Namespace.class, new Namespace("jp", "http://www.apache.org/juneaubp/";));<a name="line.131"></a> -<span class="sourceLineNo">132</span> collectionFormat = cf.getProperty(RDF_collectionFormat, RdfCollectionFormat.class, RdfCollectionFormat.DEFAULT);<a name="line.132"></a> -<span class="sourceLineNo">133</span> namespaces = cf.getProperty(RDF_namespaces, Namespace[].class, new Namespace[0]);<a name="line.133"></a> -<span class="sourceLineNo">134</span> }<a name="line.134"></a> -<span class="sourceLineNo">135</span><a name="line.135"></a> -<span class="sourceLineNo">136</span> @Override /* Context */<a name="line.136"></a> -<span class="sourceLineNo">137</span> public ObjectMap asMap() {<a name="line.137"></a> -<span class="sourceLineNo">138</span> return super.asMap()<a name="line.138"></a> -<span class="sourceLineNo">139</span> .append("RdfSerializerContext", new ObjectMap()<a name="line.139"></a> -<span class="sourceLineNo">140</span> .append("addLiteralTypes", addLiteralTypes)<a name="line.140"></a> -<span class="sourceLineNo">141</span> .append("addRootProperty", addRootProperty)<a name="line.141"></a> -<span class="sourceLineNo">142</span> .append("useXmlNamespaces", useXmlNamespaces)<a name="line.142"></a> -<span class="sourceLineNo">143</span> .append("looseCollections", looseCollections)<a name="line.143"></a> -<span class="sourceLineNo">144</span> .append("autoDetectNamespaces", autoDetectNamespaces)<a name="line.144"></a> -<span class="sourceLineNo">145</span> .append("rdfLanguage", rdfLanguage)<a name="line.145"></a> -<span class="sourceLineNo">146</span> .append("juneauNs", juneauNs)<a name="line.146"></a> -<span class="sourceLineNo">147</span> .append("juneauBpNs", juneauBpNs)<a name="line.147"></a> -<span class="sourceLineNo">148</span> .append("collectionFormat", collectionFormat)<a name="line.148"></a> -<span class="sourceLineNo">149</span> .append("namespaces", namespaces)<a name="line.149"></a> -<span class="sourceLineNo">150</span> );<a name="line.150"></a> -<span class="sourceLineNo">151</span> }<a name="line.151"></a> -<span class="sourceLineNo">152</span>}<a name="line.152"></a> +<span class="sourceLineNo">106</span> /**<a name="line.106"></a> +<span class="sourceLineNo">107</span> * <b>Configuration property:</b> Add <js>"_type"</js> properties when needed.<a name="line.107"></a> +<span class="sourceLineNo">108</span> * <p><a name="line.108"></a> +<span class="sourceLineNo">109</span> * <ul><a name="line.109"></a> +<span class="sourceLineNo">110</span> * <li><b>Name:</b> <js>"RdfSerializer.addBeanTypeProperties"</js><a name="line.110"></a> +<span class="sourceLineNo">111</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.111"></a> +<span class="sourceLineNo">112</span> * <li><b>Default:</b> <jk>false</jk><a name="line.112"></a> +<span class="sourceLineNo">113</span> * <li><b>Session-overridable:</b> <jk>true</jk><a name="line.113"></a> +<span class="sourceLineNo">114</span> * </ul><a name="line.114"></a> +<span class="sourceLineNo">115</span> * <p><a name="line.115"></a> +<span class="sourceLineNo">116</span> * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred through reflection.<a name="line.116"></a> +<span class="sourceLineNo">117</span> * This is used to recreate the correct objects during parsing if the object types cannot be inferred.<a name="line.117"></a> +<span class="sourceLineNo">118</span> * For example, when serializing a {@code Map<String,Object>} field, where the bean class cannot be determined from the value type.<a name="line.118"></a> +<span class="sourceLineNo">119</span> * <p><a name="line.119"></a> +<span class="sourceLineNo">120</span> * When present, this value overrides the {@link SerializerContext#SERIALIZER_addBeanTypeProperties} setting and is<a name="line.120"></a> +<span class="sourceLineNo">121</span> * provided to customize the behavior of specific serializers in a {@link SerializerGroup}.<a name="line.121"></a> +<span class="sourceLineNo">122</span> */<a name="line.122"></a> +<span class="sourceLineNo">123</span> public static final String RDF_addBeanTypeProperties = "RdfSerializer.addBeanTypeProperties";<a name="line.123"></a> +<span class="sourceLineNo">124</span><a name="line.124"></a> +<span class="sourceLineNo">125</span><a name="line.125"></a> +<span class="sourceLineNo">126</span> final boolean <a name="line.126"></a> +<span class="sourceLineNo">127</span> addLiteralTypes, <a name="line.127"></a> +<span class="sourceLineNo">128</span> addRootProperty, <a name="line.128"></a> +<span class="sourceLineNo">129</span> useXmlNamespaces, <a name="line.129"></a> +<span class="sourceLineNo">130</span> looseCollections, <a name="line.130"></a> +<span class="sourceLineNo">131</span> autoDetectNamespaces,<a name="line.131"></a> +<span class="sourceLineNo">132</span> addBeanTypeProperties;<a name="line.132"></a> +<span class="sourceLineNo">133</span> final String rdfLanguage;<a name="line.133"></a> +<span class="sourceLineNo">134</span> final Namespace juneauNs;<a name="line.134"></a> +<span class="sourceLineNo">135</span> final Namespace juneauBpNs;<a name="line.135"></a> +<span class="sourceLineNo">136</span> final RdfCollectionFormat collectionFormat;<a name="line.136"></a> +<span class="sourceLineNo">137</span> final Map<String,Object> jenaSettings = new HashMap<String,Object>();<a name="line.137"></a> +<span class="sourceLineNo">138</span> final Namespace[] namespaces;<a name="line.138"></a> +<span class="sourceLineNo">139</span><a name="line.139"></a> +<span class="sourceLineNo">140</span> /**<a name="line.140"></a> +<span class="sourceLineNo">141</span> * Constructor.<a name="line.141"></a> +<span class="sourceLineNo">142</span> * <p><a name="line.142"></a> +<span class="sourceLineNo">143</span> * Typically only called from {@link ContextFactory#getContext(Class)}.<a name="line.143"></a> +<span class="sourceLineNo">144</span> *<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @param cf The factory that created this context.<a name="line.145"></a> +<span class="sourceLineNo">146</span> */<a name="line.146"></a> +<span class="sourceLineNo">147</span> public RdfSerializerContext(ContextFactory cf) {<a name="line.147"></a> +<span class="sourceLineNo">148</span> super(cf);<a name="line.148"></a> +<span class="sourceLineNo">149</span> addLiteralTypes = cf.getProperty(RDF_addLiteralTypes, boolean.class, false);<a name="line.149"></a> +<span class="sourceLineNo">150</span> addRootProperty = cf.getProperty(RDF_addRootProperty, boolean.class, false);<a name="line.150"></a> +<span class="sourceLineNo">151</span> useXmlNamespaces = cf.getProperty(RDF_useXmlNamespaces, boolean.class, true);<a name="line.151"></a> +<span class="sourceLineNo">152</span> looseCollections = cf.getProperty(RDF_looseCollections, boolean.class, false);<a name="line.152"></a> +<span class="sourceLineNo">153</span> autoDetectNamespaces = cf.getProperty(RDF_autoDetectNamespaces, boolean.class, true);<a name="line.153"></a> +<span class="sourceLineNo">154</span> rdfLanguage = cf.getProperty(RDF_language, String.class, "RDF/XML-ABBREV");<a name="line.154"></a> +<span class="sourceLineNo">155</span> juneauNs = cf.getProperty(RDF_juneauNs, Namespace.class, new Namespace("j", "http://www.apache.org/juneau/";));<a name="line.155"></a> +<span class="sourceLineNo">156</span> juneauBpNs = cf.getProperty(RDF_juneauBpNs, Namespace.class, new Namespace("jp", "http://www.apache.org/juneaubp/";));<a name="line.156"></a> +<span class="sourceLineNo">157</span> collectionFormat = cf.getProperty(RDF_collectionFormat, RdfCollectionFormat.class, RdfCollectionFormat.DEFAULT);<a name="line.157"></a> +<span class="sourceLineNo">158</span> namespaces = cf.getProperty(RDF_namespaces, Namespace[].class, new Namespace[0]);<a name="line.158"></a> +<span class="sourceLineNo">159</span> addBeanTypeProperties = cf.getProperty(RDF_addBeanTypeProperties, boolean.class, cf.getProperty(SERIALIZER_addBeanTypeProperties, boolean.class, true));<a name="line.159"></a> +<span class="sourceLineNo">160</span> }<a name="line.160"></a> +<span class="sourceLineNo">161</span><a name="line.161"></a> +<span class="sourceLineNo">162</span> @Override /* Context */<a name="line.162"></a> +<span class="sourceLineNo">163</span> public ObjectMap asMap() {<a name="line.163"></a> +<span class="sourceLineNo">164</span> return super.asMap()<a name="line.164"></a> +<span class="sourceLineNo">165</span> .append("RdfSerializerContext", new ObjectMap()<a name="line.165"></a> +<span class="sourceLineNo">166</span> .append("addLiteralTypes", addLiteralTypes)<a name="line.166"></a> +<span class="sourceLineNo">167</span> .append("addRootProperty", addRootProperty)<a name="line.167"></a> +<span class="sourceLineNo">168</span> .append("useXmlNamespaces", useXmlNamespaces)<a name="line.168"></a> +<span class="sourceLineNo">169</span> .append("looseCollections", looseCollections)<a name="line.169"></a> +<span class="sourceLineNo">170</span> .append("autoDetectNamespaces", autoDetectNamespaces)<a name="line.170"></a> +<span class="sourceLineNo">171</span> .append("rdfLanguage", rdfLanguage)<a name="line.171"></a> +<span class="sourceLineNo">172</span> .append("juneauNs", juneauNs)<a name="line.172"></a> +<span class="sourceLineNo">173</span> .append("juneauBpNs", juneauBpNs)<a name="line.173"></a> +<span class="sourceLineNo">174</span> .append("collectionFormat", collectionFormat)<a name="line.174"></a> +<span class="sourceLineNo">175</span> .append("namespaces", namespaces)<a name="line.175"></a> +<span class="sourceLineNo">176</span> .append("addBeanTypeProperties", addBeanTypeProperties)<a name="line.176"></a> +<span class="sourceLineNo">177</span> );<a name="line.177"></a> +<span class="sourceLineNo">178</span> }<a name="line.178"></a> +<span class="sourceLineNo">179</span>}<a name="line.179"></a>
