yarfraw.core.datamodel
Class Enclosure

java.lang.Object
  yarfraw.core.datamodel.Enclosure

All Implemented Interfaces:

Serializable

public class Enclosure
extends Object

This is only used by Rss 2.0.
Describes a media object that is attached to the item. It has three required attributes. url says where the enclosure is located, length says how big it is in bytes, and type says what its type is, a standard MIME type.
The url must be an http url.
example: <enclosure url="http://www.scripting.com/mp3s/weatherReportSuite.mp3" length="12216320" type="audio/mpeg" />

Author:

jliang

See Also:

Serialized Form

Field Summary

protected String	_about
protected String	_base
protected String	_lang
protected Map<QName,String>	_otherAttributes
protected List<Element>	_otherElements
protected String	_resource

Constructor Summary

Enclosure()

Enclosure(String url, String length, String mimeType, String value)
It has three required attributes.

Method Summary

boolean	equals(Object other)
String	getAbout() This maps to the required 'about' attribute that present of all second level elements (channel, image, item, and textinput).
String	getAttributeValueByLocalName(String localName) Search for attributes that are not in the spec by its local name.
String	getAttributeValueByQName(QName name) Search for attributes that are not in the spec by its QName.
String	getBase() This maps to the 'base' attribute that is common in all Atom 1.0 elements.
Element	getElementByLocalName(String localName) Search through the other element list and return the FIRST element that matches the input localName.
Element	getElementByNS(String namespaceURI, String localName) Search through the other element list and return the first element that matches both input the namespaceURI and the localName.
String	getLang() The language attribute indicates the language that is used by the enclosed element.
Locale	getLangAsLocale() The language attribute indicates the language that is used by the enclosed element.
String	getLength()
Long	getLengthAsLong() Parse length attribute into a Long and returns it.
String	getMimeType()
Map<QName,String>	getOtherAttributes() Any other attribute that is not in the RSS specs.
List<Element>	getOtherElements() Other additional elements that are not in the Rss specs.
String	getResource() This maps to the optional 'resource' attribute that present in some Rss 1.0 elements.
String	getUrl()
URI	getUrlAsUri() Parse field Url to a URI object and returns it.
String	getValue()
int	hashCode()
Enclosure	setLength(String length)
Enclosure	setMimeType(String mimeType)
Enclosure	setUrl(String url)
Enclosure	setValue(String value)
String	toString()
void	validate(FeedFormat format)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_base

protected String _base

_lang

protected String _lang

_resource

protected String _resource

_about

protected String _about

_otherAttributes

protected Map<QName,String> _otherAttributes

_otherElements

protected List<Element> _otherElements

Constructor Detail

Enclosure

public Enclosure()

Enclosure

public Enclosure(String url,
                 String length,
                 String mimeType,
                 String value)

It has three required attributes. url says where the enclosure is located, length says how big it is in bytes, and type says what its type is, a standard MIME type.

Throws:

URISyntaxException

Method Detail

getUrlAsUri

public URI getUrlAsUri()
                throws URISyntaxException

Parse field Url to a URI object and returns it.

Returns:

field Url as a URI object.

Throws:

URISyntaxException

getLengthAsLong

public Long getLengthAsLong()

Parse length attribute into a Long and returns it.

Returns:

getUrl

public String getUrl()

setUrl

public Enclosure setUrl(String url)

getLength

public String getLength()

setLength

public Enclosure setLength(String length)

getMimeType

public String getMimeType()

setMimeType

public Enclosure setMimeType(String mimeType)

getValue

public String getValue()

setValue

public Enclosure setValue(String value)

validate

public void validate(FeedFormat format)
              throws ValidationException

Throws:

ValidationException

getBase

public String getBase()

This maps to the 'base' attribute that is common in all Atom 1.0 elements. Other FeedFormat will ignore this attribute.

Returns:

- attribute value.

getLang

public String getLang()

The language attribute indicates the language that is used by the enclosed element.

Returns:

- attribute value.

getLangAsLocale

public Locale getLangAsLocale()

The language attribute indicates the language that is used by the enclosed element.

Returns:

- a new Locale Object by parsing the lang attribute.

getResource

public String getResource()

This maps to the optional 'resource' attribute that present in some Rss 1.0 elements. Other FeedFormat will ignore this attribute.

Returns:

- attribute value.

getAbout

public String getAbout()

This maps to the required 'about' attribute that present of all second level elements (channel, image, item, and textinput). Other FeedFormat will ignore this attribute.

Returns:

- attribute value.

getOtherElements

public List<Element> getOtherElements()

Other additional elements that are not in the Rss specs.

getElementByNS

public Element getElementByNS(String namespaceURI,
                              String localName)

Search through the other element list and return the first element that matches both input the namespaceURI and the localName.

Parameters:

namespaceURI - - namespaceURI of the element to be search for

localName - - localName of the element

Returns:

- null if no matching element is found, the matching element otherwise.

getElementByLocalName

public Element getElementByLocalName(String localName)

Search through the other element list and return the FIRST element that matches the input localName.

Parameters:

localName - - localName of the element

Returns:

- null if no matching element is found, the matching element otherwise.

getOtherAttributes

public Map<QName,String> getOtherAttributes()

Any other attribute that is not in the RSS specs.

getAttributeValueByLocalName

public String getAttributeValueByLocalName(String localName)

Search for attributes that are not in the spec by its local name.

Parameters:

localName - localName of the attribute

Returns:

null if attribute is not found, the value of the attribute otherwise

getAttributeValueByQName

public String getAttributeValueByQName(QName name)

Search for attributes that are not in the spec by its QName.

Parameters:

name - QName of the attribute

Returns:

null if attribute is not found, the value of the attribute otherwise

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object