PatchesAndForks/rome
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Formatted and cleaned up sources

Browse source
This commit is contained in:
Patrick Gotthard 2014-05-13 19:28:29 +02:00
parent 3abba8accf
commit 0e26b54cfb
88 changed files with 2226 additions and 1316 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
src/main/java/org/rometools/feed/module/activitystreams/types/Article.java
View file

@ -18,13 +18,16 @@ package org.rometools.feed.module.activitystreams.types;
/**
* <p>
* The "article" Object type indicates that the Object is an article, such as a news article, a knowledge base entry, or other similar construct.
* The "article" Object type indicates that the Object is an article, such as a news article, a
* knowledge base entry, or other similar construct.
* </p>
* <p>
* Articles generally consist of paragraphs of text, in some cases incorporating embedded media such as photos and inline hyperlinks to other resources.
* Articles generally consist of paragraphs of text, in some cases incorporating embedded media such
* as photos and inline hyperlinks to other resources.
* </p>
* <p>
* The "Article" Object type is identified by the URL <tt>http://activitystrea.ms/schema/1.0/article</tt>.
* The "Article" Object type is identified by the URL
* <tt>http://activitystrea.ms/schema/1.0/article</tt>.
* </p>
* <p>
* An article has the following additional components:
@ -36,8 +39,9 @@ package org.rometools.feed.module.activitystreams.types;
* <dt>Name</dt>
* <dd>The title of the article. Represented by the Name component of the base Object Construct.</dd>
* <dt>Content</dt>
* <dd>The main body content of the article. Represented in JSON as a property called <tt>content</tt> whose value is a JSON string containing a fragment of
* HTML that represents the content.</dd>
* <dd>The main body content of the article. Represented in JSON as a property called
* <tt>content</tt> whose value is a JSON string containing a fragment of HTML that represents the
* content.</dd>
* </dl>
* </blockquote>
*

13
src/main/java/org/rometools/feed/module/activitystreams/types/Audio.java
View file

@ -21,7 +21,8 @@ package org.rometools.feed.module.activitystreams.types;
* The "audio" Object type represents audio content.
* </p>
* <p>
* The "audio" Object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/audio</tt>.
* The "audio" Object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/audio</tt>.
* </p>
* <p>
* An audio has the following additional components:
@ -31,11 +32,13 @@ package org.rometools.feed.module.activitystreams.types;
* <blockquote class="text">
* <dl>
* <dt>Audio Stream Link</dt>
* <dd>A Media Link Construct linking to the audio content itself. Represented in JSON as a property called <tt>stream</tt> whose value is a JSON object with
* properties as defined in [TODO: xref the JSON serialization of a Media Link Construct]</dd>
* <dd>A Media Link Construct linking to the audio content itself. Represented in JSON as a property
* called <tt>stream</tt> whose value is a JSON object with properties as defined in [TODO: xref the
* JSON serialization of a Media Link Construct]</dd>
* <dt>Embed Code</dt>
* <dd>An HTML fragment that, when embedded in an HTML page, will provide an interactive player UI for the audio stream. Represented in JSON as a property
* called <tt>embedCode</tt> whose value is a JSON string containing the fragment of HTML.</dd>
* <dd>An HTML fragment that, when embedded in an HTML page, will provide an interactive player UI
* for the audio stream. Represented in JSON as a property called <tt>embedCode</tt> whose value is
* a JSON string containing the fragment of HTML.</dd>
* </dl>
*
* @author robert.cooper

47
src/main/java/org/rometools/feed/module/activitystreams/types/Bookmark.java
View file

@ -21,27 +21,34 @@ import com.sun.syndication.feed.atom.Link;
/**
* <p>
* The "bookmark" Object type represents a pointer to some URL -- typically a web page. In most cases, a bookmark is specific to a given user and contains
* metadata chosen by that user. Bookmark Objects are similar in principle to the concept of bookmarks or favorites in a web browser. A bookmark represents a
* pointer to the URL, not the URL or the associated resource itself.
* The "bookmark" Object type represents a pointer to some URL -- typically a web page. In most
* cases, a bookmark is specific to a given user and contains metadata chosen by that user. Bookmark
* Objects are similar in principle to the concept of bookmarks or favorites in a web browser. A
* bookmark represents a pointer to the URL, not the URL or the associated resource itself.
* </p>
* <p>
* When dealing with bookmarks it is important to note the distinction between the title, description, and URL of the bookmark itself and the title, content,
* and URL of the resource that is the target of the bookmark. In some implementations these MAY be the same, but bookmark managers often allow a user to edit
* the title and description of his or her own bookmarks to differ from the metadata on the target itself.
* When dealing with bookmarks it is important to note the distinction between the title,
* description, and URL of the bookmark itself and the title, content, and URL of the resource that
* is the target of the bookmark. In some implementations these MAY be the same, but bookmark
* managers often allow a user to edit the title and description of his or her own bookmarks to
* differ from the metadata on the target itself.
* </p>
* <p>
* Some implementations refer to this Object type as a "link". This specification uses the term "bookmark" to avoid confusion with the general concept of
* hyperlinks which apply to all Object types.
* Some implementations refer to this Object type as a "link". This specification uses the term
* "bookmark" to avoid confusion with the general concept of hyperlinks which apply to all Object
* types.
* </p>
* <p>
* Since bookmarks are often specific to a particular user, even though multiple users might have bookmarks pointing at the same resource, it is appropriate to
* use the "post" Verb to describe the publication of such a bookmark. The "mark as favorite" Verb SHOULD be used when a user flags another user's bookmark as
* being a favorite without creating his own bookmark, or when a user flags his own bookmark as being a favorite as a special classification within his own
* bookmark collection.
* Since bookmarks are often specific to a particular user, even though multiple users might have
* bookmarks pointing at the same resource, it is appropriate to use the "post" Verb to describe the
* publication of such a bookmark. The "mark as favorite" Verb SHOULD be used when a user flags
* another user's bookmark as being a favorite without creating his own bookmark, or when a user
* flags his own bookmark as being a favorite as a special classification within his own bookmark
* collection.
* </p>
* <p>
* The "bookmark" Object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/bookmark</tt>.
* The "bookmark" Object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/bookmark</tt>.
* </p>
* <p>
* A bookmark has the following additional components:
@ -51,14 +58,16 @@ import com.sun.syndication.feed.atom.Link;
* <blockquote class="text">
* <dl>
* <dt>Title</dt>
* <dd>The title of the bookmark, as entered by the user who created the bookmark. Represented by the Name component of the base Object Construct. Publishers
* MAY use the title of the target resource as a default for this property where a user hasn't entered a customized value.</dd>
* <dd>The title of the bookmark, as entered by the user who created the bookmark. Represented by
* the Name component of the base Object Construct. Publishers MAY use the title of the target
* resource as a default for this property where a user hasn't entered a customized value.</dd>
* <dt>Target URL</dt>
* <dd>The URL of the item that is the target of the bookmark. Represented in JSON by a property called <tt>targetUrl</tt> whose value is a JSON string
* containing the target URL.</dd>
* <dd>The URL of the item that is the target of the bookmark. Represented in JSON by a property
* called <tt>targetUrl</tt> whose value is a JSON string containing the target URL.</dd>
* <dt>Thumbnail</dt>
* <dd>The URL and metadata for a thumbnail version of the page. Represented by the Representative Image component of the base Object Construct. Processors MAY
* ignore thumbnails that are of an inappropriate size for their user interface.</dd>
* <dd>The URL and metadata for a thumbnail version of the page. Represented by the Representative
* Image component of the base Object Construct. Processors MAY ignore thumbnails that are of an
* inappropriate size for their user interface.</dd>
* </dl>
* </blockquote>
*

21
src/main/java/org/rometools/feed/module/activitystreams/types/Comment.java
View file

@ -22,10 +22,12 @@ package org.rometools.feed.module.activitystreams.types;
* The "comment" object type represents a textual response to another object.
* </p>
* <p>
* The comment object type MUST NOT be used for other kinds of replies, such as video replies or reviews.
* The comment object type MUST NOT be used for other kinds of replies, such as video replies or
* reviews.
* </p>
* <p>
* The "comment" object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/comment</tt>.
* The "comment" object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/comment</tt>.
* </p>
* <p>
* A comment has the following additional components:
@ -35,13 +37,16 @@ package org.rometools.feed.module.activitystreams.types;
* <blockquote class="text">
* <dl>
* <dt>Subject</dt>
* <dd>The subject of the comment. Represented by the Name component of the base Object Construct. Many systems do not have the concept of a title or subject
* for a comment; such systems MUST omit the Name component. Processors SHOULD refer to such comments as simply being "a comment", with appropriate
* localization, if they are to be described in a sentence.</dd>
* <dd>The subject of the comment. Represented by the Name component of the base Object Construct.
* Many systems do not have the concept of a title or subject for a comment; such systems MUST omit
* the Name component. Processors SHOULD refer to such comments as simply being "a comment", with
* appropriate localization, if they are to be described in a sentence.</dd>
* <dt>Content</dt>
* <dd>The content of the comment. Represented in JSON as a property called <tt>content</tt> whose value is a JSON string containing a fragment of HTML that
* represents the content. Publishers SHOULD include any markup necessary to achieve a similar presentation to that on the publisher's own HTML pages, including
* any links that the service automatically adds. Processors MAY remove all HTML markup and consider the comment to be plain text.</dd>
* <dd>The content of the comment. Represented in JSON as a property called <tt>content</tt> whose
* value is a JSON string containing a fragment of HTML that represents the content. Publishers
* SHOULD include any markup necessary to achieve a similar presentation to that on the publisher's
* own HTML pages, including any links that the service automatically adds. Processors MAY remove
* all HTML markup and consider the comment to be plain text.</dd>
* </dl>
* </blockquote>
*

16
src/main/java/org/rometools/feed/module/activitystreams/types/Event.java
View file

@ -19,10 +19,12 @@ package org.rometools.feed.module.activitystreams.types;
/**
* <p>
* The "event" object type represents an event that occurs in a certain place during a particular interval of time.
* The "event" object type represents an event that occurs in a certain place during a particular
* interval of time.
* </p>
* <p>
* The object type URL for the "event" object type is <tt>http://activitystrea.ms/schema/1.0/event</tt>.
* The object type URL for the "event" object type is
* <tt>http://activitystrea.ms/schema/1.0/event</tt>.
* </p>
* <p>
* An event has the following additional components:
@ -32,11 +34,13 @@ package org.rometools.feed.module.activitystreams.types;
* <blockquote class="text">
* <dl>
* <dt>Start Date and Time</dt>
* <dd>The date and time that the event begins. Represented in JSON as a property called <tt>startTime</tt> whose value is JSON string containing a W3CDTF
* timestamp. [TODO: Reference W3CDTF spec.] [TODO: Include prose describing how to represent just a date vs. a date and time.]</dd>
* <dd>The date and time that the event begins. Represented in JSON as a property called
* <tt>startTime</tt> whose value is JSON string containing a W3CDTF timestamp. [TODO: Reference
* W3CDTF spec.] [TODO: Include prose describing how to represent just a date vs. a date and time.]</dd>
* <dt>End Date and Time</dt>
* <dd>The date and time that the event ends. Represented in JSON as a property called <tt>endTime</tt> whose value is JSON string containing a W3CDTF
* timestamp. [TODO: Reference W3CDTF spec.] [TODO: Include prose describing how to represent just a date vs. a date and time.]</dd>
* <dd>The date and time that the event ends. Represented in JSON as a property called
* <tt>endTime</tt> whose value is JSON string containing a W3CDTF timestamp. [TODO: Reference
* W3CDTF spec.] [TODO: Include prose describing how to represent just a date vs. a date and time.]</dd>
* </dl>
* </blockquote>
*

16
src/main/java/org/rometools/feed/module/activitystreams/types/File.java
View file

@ -19,11 +19,13 @@ package org.rometools.feed.module.activitystreams.types;
/**
* <p>
* The "file" Object type represents some document or other file with no additional machine-readable semantics.
* The "file" Object type represents some document or other file with no additional machine-readable
* semantics.
* </p>
* <p>
* It is intended that this type be used as a base type for other Objects that manifest as files, so that additional semantics can be added while providing a
* fallback ability for clients that do not support the more specific Object type.
* It is intended that this type be used as a base type for other Objects that manifest as files, so
* that additional semantics can be added while providing a fallback ability for clients that do not
* support the more specific Object type.
* </p>
* <p>
* The "file" Object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/file</tt>.
@ -36,11 +38,11 @@ package org.rometools.feed.module.activitystreams.types;
* <blockquote class="text">
* <dl>
* <dt>Associated File URL</dt>
* <dd>The URL of the file described by this Object Construct. Represented in JSON by a property called <tt>fileUrl</tt> whose value is a JSON string containing
* the URL.</dd>
* <dd>The URL of the file described by this Object Construct. Represented in JSON by a property
* called <tt>fileUrl</tt> whose value is a JSON string containing the URL.</dd>
* <dt>File MIME Type</dt>
* <dd>The MIME type of the file described by this Object Construct. Represented in JSON by a property called <tt>mimeType</tt> whose value is a JSON string
* containing the MIME type.</dd>
* <dd>The MIME type of the file described by this Object Construct. Represented in JSON by a
* property called <tt>mimeType</tt> whose value is a JSON string containing the MIME type.</dd>
* </dl>
* </blockquote>
*

12
src/main/java/org/rometools/feed/module/activitystreams/types/Folder.java
View file

@ -19,11 +19,12 @@ package org.rometools.feed.module.activitystreams.types;
/**
* <p>
* The "folder" object type represents a collection of files or media objects. This is similar to the "photo album" object type, but not specifically
* representing a collection of "photos."
* The "folder" object type represents a collection of files or media objects. This is similar to
* the "photo album" object type, but not specifically representing a collection of "photos."
* </p>
* <p>
* The "folder" object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/folder</tt>.
* The "folder" object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/folder</tt>.
* </p>
* <p>
* A folder has the following additional components:
@ -33,8 +34,9 @@ package org.rometools.feed.module.activitystreams.types;
* <blockquote class="text">
* <dl>
* <dt>Preview Image Link</dt>
* <dd>A Media Link Construct describing an image file that can be used as a preview image for the folder. Represented by the Representative Image component of
* the base Object Construct. Processors MAY ignore thumbnails that are of an inappropriate size for their user interface.</dd>
* <dd>A Media Link Construct describing an image file that can be used as a preview image for the
* folder. Represented by the Representative Image component of the base Object Construct.
* Processors MAY ignore thumbnails that are of an inappropriate size for their user interface.</dd>
* </dl>
* </blockquote>
*

6
src/main/java/org/rometools/feed/module/activitystreams/types/Group.java
View file

@ -19,10 +19,12 @@ package org.rometools.feed.module.activitystreams.types;
/**
* <p>
* The "group" Object type represents a social networking group. A group is a collection of people which people can join and leave.
* The "group" Object type represents a social networking group. A group is a collection of people
* which people can join and leave.
* </p>
* <p>
* The "group" Object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/group</tt>.
* The "group" Object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/group</tt>.
* </p>
* <p>
* A group has no additional components.

21
src/main/java/org/rometools/feed/module/activitystreams/types/HasLocation.java
View file

@ -22,15 +22,19 @@ import org.rometools.feed.module.portablecontacts.ContactModule;
/**
* <p>
* Location is a concept which can be used inside the atom:entry level, atom:author and activity:object. Location can be specified via geographic coordinates, a
* street address, a free-form location name or a combination of these. Geographic coordinates should be included as a geo:point element as described by the
* GeoRSS specification. Addresses should be included using a poco:address element defined at Portable Contacts specification. The entry level location
* represents the location of the author at the time the activity was performed. The author level location represents the primary location of the author.
* Finally, the location within other objects represents the physical location of those objects. All location fields are optional. For free form addresses use
* the poco:formatted field.
* Location is a concept which can be used inside the atom:entry level, atom:author and
* activity:object. Location can be specified via geographic coordinates, a street address, a
* free-form location name or a combination of these. Geographic coordinates should be included as a
* geo:point element as described by the GeoRSS specification. Addresses should be included using a
* poco:address element defined at Portable Contacts specification. The entry level location
* represents the location of the author at the time the activity was performed. The author level
* location represents the primary location of the author. Finally, the location within other
* objects represents the physical location of those objects. All location fields are optional. For
* free form addresses use the poco:formatted field.
* </p>
* <p>
* <a class='info' href='#location-poco'>Figure&nbsp;1<span> (</span><span class='info'>Location Example</span><span>)</span></a>
* <a class='info' href='#location-poco'>Figure&nbsp;1<span> (</span><span class='info'>Location
* Example</span><span>)</span></a>
* </p>
* <p>
* <br />
@ -77,7 +81,8 @@ import org.rometools.feed.module.portablecontacts.ContactModule;
* <p>
* <table border="0" cellpadding="0" cellspacing="2" align="center">
* <tr>
* <td align="center"><font face="monaco, MS Sans Serif" size="1"><b>&nbsp;Figure&nbsp;1: Location Example&nbsp;</b></font><br />
* <td align="center"><font face="monaco, MS Sans Serif" size="1"><b>&nbsp;Figure&nbsp;1: Location
* Example&nbsp;</b></font><br />
* </td>
* </tr>
* </table>

11
src/main/java/org/rometools/feed/module/activitystreams/types/Mood.java
View file

@ -19,8 +19,10 @@ package org.rometools.feed.module.activitystreams.types;
/**
*
* <p>
* Mood describes the mood of the user when the activity was performed. This is usually collected via an extra field in the user interface used to perform the
* activity. For the purpose of this schema, a mood is a freeform, short mood keyword or phrase along with an optional mood icon image.
* Mood describes the mood of the user when the activity was performed. This is usually collected
* via an extra field in the user interface used to perform the activity. For the purpose of this
* schema, a mood is a freeform, short mood keyword or phrase along with an optional mood icon
* image.
* </p>
* <p>
* Moods are included via a mood element in the namespace <tt>http://activitystrea.ms/context/</tt>.
@ -29,8 +31,9 @@ package org.rometools.feed.module.activitystreams.types;
* The content of the mood element is the mood keyword or phrase.
* </p>
* <p>
* The mood element may have an optional <tt>icon</tt> attribute which contains the URL of a mood icon image. The mood icon image SHOULD be small and
* appropriate to be displayed alongside the mood keyword at a normal text size.
* The mood element may have an optional <tt>icon</tt> attribute which contains the URL of a mood
* icon image. The mood icon image SHOULD be small and appropriate to be displayed alongside the
* mood keyword at a normal text size.
* </p>
*
* @author robert.cooper

18
src/main/java/org/rometools/feed/module/activitystreams/types/Note.java
View file

@ -19,12 +19,14 @@ package org.rometools.feed.module.activitystreams.types;
/**
* <p>
* The "note" Object type represents short-form text messages. This Object type is intended for use in "micro-blogging" and in systems where users are invited
* to publish short, often plain-text messages whose useful lifespan is generally shorter than that of an article or weblog entry.
* The "note" Object type represents short-form text messages. This Object type is intended for use
* in "micro-blogging" and in systems where users are invited to publish short, often plain-text
* messages whose useful lifespan is generally shorter than that of an article or weblog entry.
* </p>
* <p>
* A note is similar in structure to an article, but it does not have a title and its body tends to be shorter. Applications will often display the entire
* content of a note in an activity stream UI, whereas they MAY display only the title or the title and summary for a weblog entry.
* A note is similar in structure to an article, but it does not have a title and its body tends to
* be shorter. Applications will often display the entire content of a note in an activity stream
* UI, whereas they MAY display only the title or the title and summary for a weblog entry.
* </p>
* <p>
* The "note" Object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/note</tt>.
@ -37,9 +39,11 @@ package org.rometools.feed.module.activitystreams.types;
* <blockquote class="text">
* <dl>
* <dt>Content</dt>
* <dd>The content of the comment. Represented in JSON as a property called <tt>content</tt> whose value is a JSON string containing a fragment of HTML that
* represents the content. Publishers SHOULD include any markup necessary to achieve a similar presentation to that on the publisher's own HTML pages, including
* any links that the service automatically adds. Processors MAY remove all HTML markup and consider the comment to be plain text.</dd>
* <dd>The content of the comment. Represented in JSON as a property called <tt>content</tt> whose
* value is a JSON string containing a fragment of HTML that represents the content. Publishers
* SHOULD include any markup necessary to achieve a similar presentation to that on the publisher's
* own HTML pages, including any links that the service automatically adds. Processors MAY remove
* all HTML markup and consider the comment to be plain text.</dd>
* </dl>
* </blockquote>
*

15
src/main/java/org/rometools/feed/module/activitystreams/types/Person.java
View file

@ -21,11 +21,12 @@ import com.sun.syndication.feed.atom.Link;
/**
* <p>
* The "person" Object type represents a user account. This is often represents a person, but might also be a company or fictitious character that is being
* represented by a user account.
* The "person" Object type represents a user account. This is often represents a person, but might
* also be a company or fictitious character that is being represented by a user account.
* </p>
* <p>
* The "person" Object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/person</tt>.
* The "person" Object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/person</tt>.
* </p>
* <p>
* A person has the following additional components:
@ -35,10 +36,12 @@ import com.sun.syndication.feed.atom.Link;
* <blockquote class="text">
* <dl>
* <dt>Display Name</dt>
* <dd>A name that can be used for the person in the user interface. This is often a name by which the individual is known in a given context; no restriction is
* placed on what kind of name may be used here. Represented by the Name component of the base Object Construct.</dd>
* <dd>A name that can be used for the person in the user interface. This is often a name by which
* the individual is known in a given context; no restriction is placed on what kind of name may be
* used here. Represented by the Name component of the base Object Construct.</dd>
* <dt>Avatar</dt>
* <dd>A link to an "avatar" or "userpic" image for the user. Represented by the Representative Image component of the base Object Construct.</dd>
* <dd>A link to an "avatar" or "userpic" image for the user. Represented by the Representative
* Image component of the base Object Construct.</dd>
* </dl>
* </blockquote>
*

14
src/main/java/org/rometools/feed/module/activitystreams/types/Photo.java
View file

@ -22,7 +22,8 @@ package org.rometools.feed.module.activitystreams.types;
* The "photo" object type represents a graphical still image.
* </p>
* <p>
* The "photo" Object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/photo</tt>.
* The "photo" Object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/photo</tt>.
* </p>
* <p>
* A photo has the following additional components:
@ -32,11 +33,14 @@ package org.rometools.feed.module.activitystreams.types;
* <blockquote class="text">
* <dl>
* <dt>Thumbnail</dt>
* <dd>A link to a thumbnail version of the image. Represented by the Representative Image component of the base Object Construct. Processors MAY ignore
* thumbnails that are of an inappropriate size for their user interface.</dd>
* <dd>A link to a thumbnail version of the image. Represented by the Representative Image component
* of the base Object Construct. Processors MAY ignore thumbnails that are of an inappropriate size
* for their user interface.</dd>
* <dt>Larger Image</dt>
* <dd>A Media Link Construct linking to a larger -- ideally, full-size -- version of the photo intended for standalone viewing. Represented in JSON as a
* property named <tt>fullImage</tt> whose value is a JSON object with properties as defined in [TODO: xref the JSON serialization of a Media Link Construct].</dd>
* <dd>A Media Link Construct linking to a larger -- ideally, full-size -- version of the photo
* intended for standalone viewing. Represented in JSON as a property named <tt>fullImage</tt> whose
* value is a JSON object with properties as defined in [TODO: xref the JSON serialization of a
* Media Link Construct].</dd>
* </dl>
* </blockquote>
*

8
src/main/java/org/rometools/feed/module/activitystreams/types/PhotoAlbum.java
View file

@ -22,7 +22,8 @@ package org.rometools.feed.module.activitystreams.types;
* The "photo album" object type represents a collection of images.
* </p>
* <p>
* The "photo album" object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/photo-album</tt>.
* The "photo album" object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/photo-album</tt>.
* </p>
* <p>
* The photo album has the following additional components:
@ -32,8 +33,9 @@ package org.rometools.feed.module.activitystreams.types;
* <blockquote class="text">
* <dl>
* <dt>Preview Image Link</dt>
* <dd>A Media Link Construct describing an image file that can be used as a preview image for the album. Represented by the Representative Image component of
* the base Object Construct. Processors MAY ignore thumbnails that are of an inappropriate size for their user interface.</dd>
* <dd>A Media Link Construct describing an image file that can be used as a preview image for the
* album. Represented by the Representative Image component of the base Object Construct. Processors
* MAY ignore thumbnails that are of an inappropriate size for their user interface.</dd>
* </dl>
* </blockquote>
*

13
src/main/java/org/rometools/feed/module/activitystreams/types/Place.java
View file

@ -22,7 +22,8 @@ package org.rometools.feed.module.activitystreams.types;
* The "place" object type represents a location on Earth.
* </p>
* <p>
* The "place" object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/place</tt>.
* The "place" object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/place</tt>.
* </p>
* <p>
* A place has the following additional components:
@ -32,11 +33,13 @@ package org.rometools.feed.module.activitystreams.types;
* <blockquote class="text">
* <dl>
* <dt>Latitude</dt>
* <dd>The latitude of the place as a point on Earth. Represented in JSON as a property named <tt>latitude</tt> whose value is a JSON number containing a
* decimal representation of the latitude in degrees.</dd>
* <dd>The latitude of the place as a point on Earth. Represented in JSON as a property named
* <tt>latitude</tt> whose value is a JSON number containing a decimal representation of the
* latitude in degrees.</dd>
* <dt>Longitude</dt>
* <dd>The longitude of the place as a point on Earth. Represented in JSON as a property named <tt>longitude</tt> whose value is a JSON number containing a
* decimal representation of the longitude in degrees.</dd>
* <dd>The longitude of the place as a point on Earth. Represented in JSON as a property named
* <tt>longitude</tt> whose value is a JSON number containing a decimal representation of the
* longitude in degrees.</dd>
* </dl>
* </blockquote>
*

6
src/main/java/org/rometools/feed/module/activitystreams/types/Playlist.java
View file

@ -20,10 +20,12 @@ package org.rometools.feed.module.activitystreams.types;
/**
*
* <p>
* The "playlist" object type represents an ordered list of time-based media items, such as video and audio objects.
* The "playlist" object type represents an ordered list of time-based media items, such as video
* and audio objects.
* </p>
* <p>
* The "playlist" object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/playlist</tt>.
* The "playlist" object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/playlist</tt>.
* </p>
* <p>
* A playlist has no additional components.

14
src/main/java/org/rometools/feed/module/activitystreams/types/Product.java
View file

@ -22,7 +22,8 @@ package org.rometools.feed.module.activitystreams.types;
* The "product" object type represents a commercial good or service.
* </p>
* <p>
* The "product" object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/product</tt>.
* The "product" object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/product</tt>.
* </p>
* <p>
* A product has the following additional components:
@ -32,11 +33,14 @@ package org.rometools.feed.module.activitystreams.types;
* <blockquote class="text">
* <dl>
* <dt>Thumbnail</dt>
* <dd>A link to a thumbnail-sized image that contains a photo of the product. Represented by the Representative Image component of the base Object Construct.
* Processors MAY ignore thumbnails that are of an inappropriate size for their user interface.</dd>
* <dd>A link to a thumbnail-sized image that contains a photo of the product. Represented by the
* Representative Image component of the base Object Construct. Processors MAY ignore thumbnails
* that are of an inappropriate size for their user interface.</dd>
* <dt>Larger Image</dt>
* <dd>A Media Link Construct linking to a larger -- ideally, full-size -- version of the photo of the product. Represented in JSON as a property named
* <tt>fullImage</tt> whose value is a JSON object with properties as defined in [TODO: xref the JSON serialization of a Media Link Construct].</dd>
* <dd>A Media Link Construct linking to a larger -- ideally, full-size -- version of the photo of
* the product. Represented in JSON as a property named <tt>fullImage</tt> whose value is a JSON
* object with properties as defined in [TODO: xref the JSON serialization of a Media Link
* Construct].</dd>
* </dl>
* </blockquote>
*

26
src/main/java/org/rometools/feed/module/activitystreams/types/Review.java
View file

@ -22,7 +22,8 @@ package org.rometools.feed.module.activitystreams.types;
* The "review" object type represents a primarily prose-based commentary on another object.
* </p>
* <p>
* The "review" object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/review</tt>.
* The "review" object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/review</tt>.
* </p>
* <p>
* A review has the following additional components:
@ -32,18 +33,23 @@ package org.rometools.feed.module.activitystreams.types;
* <blockquote class="text">
* <dl>
* <dt>Title</dt>
* <dd>The title of the review. Represented by the Name component of the base Object Construct. Many systems do not have the concept of a title for a review;
* such systems MUST omit the Name component. Processors SHOULD refer to such reviews as simply being "a review", with appropriate localization, if they are to
* be described in a sentence.</dd>
* <dd>The title of the review. Represented by the Name component of the base Object Construct. Many
* systems do not have the concept of a title for a review; such systems MUST omit the Name
* component. Processors SHOULD refer to such reviews as simply being "a review", with appropriate
* localization, if they are to be described in a sentence.</dd>
* <dt>Content</dt>
* <dd>The content of the comment. Represented in JSON as a property called <tt>content</tt> whose value is a JSON string containing a fragment of HTML that
* represents the content. Publishers SHOULD include any markup necessary to achieve a similar presentation to that on the publisher's own HTML pages, including
* any links that the service automatically adds. Processors MAY remove all HTML markup and consider the comment to be plain text.</dd>
* <dd>The content of the comment. Represented in JSON as a property called <tt>content</tt> whose
* value is a JSON string containing a fragment of HTML that represents the content. Publishers
* SHOULD include any markup necessary to achieve a similar presentation to that on the publisher's
* own HTML pages, including any links that the service automatically adds. Processors MAY remove
* all HTML markup and consider the comment to be plain text.</dd>
* <dt>Reviewed Object</dt>
* <dd>The Object Construct representing the item that this review applies to. Represented as the In Reply To Object component of the base Object Construct.</dd>
* <dd>The Object Construct representing the item that this review applies to. Represented as the In
* Reply To Object component of the base Object Construct.</dd>
* <dt>Rating</dt>
* <dd>A rating for the item, given as a number between 1.0 and 5.0 inclusive with one decimal place of precision. Represented in JSON as a property called
* <tt>rating</tt> whose value is a JSON number giving the rating.</dd>
* <dd>A rating for the item, given as a number between 1.0 and 5.0 inclusive with one decimal place
* of precision. Represented in JSON as a property called <tt>rating</tt> whose value is a JSON
* number giving the rating.</dd>
* </dl>
* </blockquote>
*

16
src/main/java/org/rometools/feed/module/activitystreams/types/Service.java
View file

@ -19,11 +19,13 @@ package org.rometools.feed.module.activitystreams.types;
/**
* <p>
* The "service" Object type represents a website, personal website or blog, business, brand, or other entity that performs some kind of work for other
* entities, people, or services, or acts as kind of container for other objects.
* The "service" Object type represents a website, personal website or blog, business, brand, or
* other entity that performs some kind of work for other entities, people, or services, or acts as
* kind of container for other objects.
* </p>
* <p>
* The "service" Object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/service</tt>.
* The "service" Object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/service</tt>.
* </p>
* <p>
* A service has the following additional components:
@ -33,9 +35,11 @@ package org.rometools.feed.module.activitystreams.types;
* <blockquote class="text">
* <dl>
* <dt>icon</dt>
* <dd>A Media Link Construct representing a link to a small image representing the service. Represented in JSON as a property named <tt>icon</tt> whose value
* is a JSON object with properties as defined in [TODO: xref the JSON serialization of a Media Link Construct]. The linked image MUST have an aspect ratio of
* one (horizontal) to one (vertical) and SHOULD be suitable for presentation at a small size.</dd>
* <dd>A Media Link Construct representing a link to a small image representing the service.
* Represented in JSON as a property named <tt>icon</tt> whose value is a JSON object with
* properties as defined in [TODO: xref the JSON serialization of a Media Link Construct]. The
* linked image MUST have an aspect ratio of one (horizontal) to one (vertical) and SHOULD be
* suitable for presentation at a small size.</dd>
* </dl>
* </blockquote>
*

13
src/main/java/org/rometools/feed/module/activitystreams/types/Song.java
View file

@ -21,13 +21,16 @@ package org.rometools.feed.module.activitystreams.types;
* The "song" Object type represents a song or a recording of a song.
* </p>
* <p>
* Objects of type Song might contain information about the song or recording, or they might contain some representation of the recording itself. In the latter
* case, the song SHOULD also be annotated with the "audio" object type as described in <a class='info' href='#audio'>Section&nbsp;3.2.2<span> (</span><span
* class='info'>Audio</span><span>)</span></a> and use its properties. This type should only be used when the publisher can guarantee that the object is a song
* rather than merely a generic audio stream.
* Objects of type Song might contain information about the song or recording, or they might contain
* some representation of the recording itself. In the latter case, the song SHOULD also be
* annotated with the "audio" object type as described in <a class='info'
* href='#audio'>Section&nbsp;3.2.2<span> (</span><span class='info'>Audio</span><span>)</span></a>
* and use its properties. This type should only be used when the publisher can guarantee that the
* object is a song rather than merely a generic audio stream.
* </p>
* <p>
* The Object type URL for the "song" Object type is <tt>http://activitystrea.ms/schema/1.0/song</tt>.
* The Object type URL for the "song" Object type is
* <tt>http://activitystrea.ms/schema/1.0/song</tt>.
* </p>
* <p>
* A song has no additional components.

15
src/main/java/org/rometools/feed/module/activitystreams/types/Status.java
View file

@ -19,18 +19,21 @@ package org.rometools.feed.module.activitystreams.types;
/**
* <p>
* The "status" Object type represents a human-readable update of the author's situation, mood, location or other status.
* The "status" Object type represents a human-readable update of the author's situation, mood,
* location or other status.
* </p>
* <p>
* A status is similar in structure to a note, but carries the additional meaning that the content is primarily describing something its author is doing,
* feeling or experiencing.
* A status is similar in structure to a note, but carries the additional meaning that the content
* is primarily describing something its author is doing, feeling or experiencing.
* </p>
* <p>
* A consumers MAY consider the content of the most recent status object it encountered to be the user's current status, unless the most recent status update is
* old. When a status becomes too old is not defined by this specification.
* A consumers MAY consider the content of the most recent status object it encountered to be the
* user's current status, unless the most recent status update is old. When a status becomes too old
* is not defined by this specification.
* </p>
* <p>
* The "status" object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/status</tt>.
* The "status" object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/status</tt>.
* </p>
* <p>
* A status has the same components as a note.

123
src/main/java/org/rometools/feed/module/activitystreams/types/Verb.java
View file

@ -22,20 +22,24 @@ package org.rometools.feed.module.activitystreams.types;
*/
public enum Verb {
/**
* The "mark as favorite" Verb indicates that the Subject marked the Object as an item of special interest. Objects so marked often appear in a collection
* of such Objects which MAY be published as a feed of entries annotated with this Verb. If a particular service uses favorites as a mechanism by which a
* user can recall items that were earlier marked, it MAY be appropriate to also mark activities of this type with the "save" Verb as described in Section
* 3.1.8. The verb URI for the "mark as favorite" Verb is http://activitystrea.ms/schema/1.0/favorite.
* The "mark as favorite" Verb indicates that the Subject marked the Object as an item of
* special interest. Objects so marked often appear in a collection of such Objects which MAY be
* published as a feed of entries annotated with this Verb. If a particular service uses
* favorites as a mechanism by which a user can recall items that were earlier marked, it MAY be
* appropriate to also mark activities of this type with the "save" Verb as described in Section
* 3.1.8. The verb URI for the "mark as favorite" Verb is
* http://activitystrea.ms/schema/1.0/favorite.
*/
MARK_AS_FAVORITE("http://activitystrea.ms/schema/1.0/favorite"),
/**
* The "start following" Verb indicates that the Subject began following the activity of the Object. In most cases, the Object of this Verb will be a user,
* but it can potentially be of any type that can sensibly generate activity.
* The "start following" Verb indicates that the Subject began following the activity of the
* Object. In most cases, the Object of this Verb will be a user, but it can potentially be of
* any type that can sensibly generate activity.
*
* The verb URI for the "start following" Verb is http://activitystrea.ms/schema/1.0/follow.
*
* Processors MAY ignore (silently drop) successive identical "start following" activities regardless of whether they maintain state sufficient to determine
* (A), (B), or (C) above.
* Processors MAY ignore (silently drop) successive identical "start following" activities
* regardless of whether they maintain state sufficient to determine (A), (B), or (C) above.
*/
START_FOLLOWING("http://activitystrea.ms/schema/1.0/follow"),
/**
@ -45,68 +49,79 @@ public enum Verb {
*/
MARK_AS_LIKED("http://activitystrea.ms/schema/1.0/like"),
/**
* The "make friend" Verb indicates the creation of a friendship that is reciprocated by the object.
* The "make friend" Verb indicates the creation of a friendship that is reciprocated by the
* object.
*
* Since this verb implies an activity on the part of its object, processors MUST NOT accept activities with this Verb unless they are able to verify
* through some external means that there is in fact a reciprocated connection. For example, a processor MAY have received a guarantee from a particular
* publisher that the publisher will only use this Verb in cases where a reciprocal relationship exists.
* Since this verb implies an activity on the part of its object, processors MUST NOT accept
* activities with this Verb unless they are able to verify through some external means that
* there is in fact a reciprocated connection. For example, a processor MAY have received a
* guarantee from a particular publisher that the publisher will only use this Verb in cases
* where a reciprocal relationship exists.
*
* The verb URI for the "make friend" Verb is http://activitystrea.ms/schema/1.0/make-friend.
*/
MAKE_FRIEND("http://activitystrea.ms/schema/1.0/make-friend"),
/**
* The "join" Verb indicates that the actor has become a member of the Object. This specification only defines the meaning of this Verb when its Object is a
* Group, though implementors SHOULD be prepared to handle other Object types as meaning MAY be provided by extension specifications.
* The "join" Verb indicates that the actor has become a member of the Object. This
* specification only defines the meaning of this Verb when its Object is a Group, though
* implementors SHOULD be prepared to handle other Object types as meaning MAY be provided by
* extension specifications.
*
* Processors MAY ignore (silently drop) successive identical "join" activities regardless of whether they maintain state sufficient to determine (A) or (B)
* above.
* Processors MAY ignore (silently drop) successive identical "join" activities regardless of
* whether they maintain state sufficient to determine (A) or (B) above.
*
* The "join" Verb is identified by the URI http://activitystrea.ms/schema/1.0/join.
*/
JOIN("http://activitystrea.ms/schema/1.0/join"),
/**
* The "play" verb indicates that the subject spent some time enjoying the object. For example, if the object is a video this indicates that the subject
* watched all or part of the video.
* The "play" verb indicates that the subject spent some time enjoying the object. For example,
* if the object is a video this indicates that the subject watched all or part of the video.
*
* The "play" Verb is identified by the URI http://activitystrea.ms/schema/1.0/play.
*/
PLAY("http://activitystrea.ms/schema/1.0/play"),
/**
* The "Post" Verb is described in section 8 of the AtomActivity specification. It is only referenced here for completeness.
* The "Post" Verb is described in section 8 of the AtomActivity specification. It is only
* referenced here for completeness.
*
* http://activitystrea.ms/schema/1.0/post
*/
POST("http://activitystrea.ms/schema/1.0/post"),
/**
* The "save" Verb indicates that the Subject has called out the Object as being of interest primarily to him- or herself. Though this action MAY be shared
* publicly, the implication is that the Object has been saved primarily for the actor's own benefit rather than to show it to others as would be indicated
* by the "share" Verb (Section 3.1.9).
* The "save" Verb indicates that the Subject has called out the Object as being of interest
* primarily to him- or herself. Though this action MAY be shared publicly, the implication is
* that the Object has been saved primarily for the actor's own benefit rather than to show it
* to others as would be indicated by the "share" Verb (Section 3.1.9).
*
* The "save" Verb is identified by the URI http://activitystrea.ms/schema/1.0/save.
*/
SAVE("http://activitystrea.ms/schema/1.0/save"),
/**
* The "share" Verb indicates that the Subject has called out the Object to readers. In most cases, the actor did not create the Object being shared, but is
* instead drawing attention to it.
* The "share" Verb indicates that the Subject has called out the Object to readers. In most
* cases, the actor did not create the Object being shared, but is instead drawing attention to
* it.
*
* The "share" Verb is identified by the URI http://activitystrea.ms/schema/1.0/share.
*/
SHARE("http://activitystrea.ms/schema/1.0/share"),
/**
* The "tag" verb indicates that the actor has identified the presence of a target inside another object. For example, the actor may have specified that a
* particular user appears in a photo.
* The "tag" verb indicates that the actor has identified the presence of a target inside
* another object. For example, the actor may have specified that a particular user appears in a
* photo.
*
* The "tag" verb is identified by the URI http://activitystrea.ms/schema/1.0/tag.
*
* The target of the "tag" verb gives the object in which the tag has been added. For example, if a user appears in a photo, the activity:object is the user
* and the activity:target is the photo.
* The target of the "tag" verb gives the object in which the tag has been added. For example,
* if a user appears in a photo, the activity:object is the user and the activity:target is the
* photo.
*/
TAG("http://activitystrea.ms/schema/1.0/tag"),
/**
* The "update" Verb indicates that the Subject has modified the referenced Object.
*
* Implementors SHOULD use verbs such as Section 3.1.7 where the Subject is adding new items to a Section 3.2.8 or similar. Update is reserved for
* modifications to existing Objects or data such as changing a user's profile information.
* Implementors SHOULD use verbs such as Section 3.1.7 where the Subject is adding new items to
* a Section 3.2.8 or similar. Update is reserved for modifications to existing Objects or data
* such as changing a user's profile information.
*
* The "update" Verb is identified by the URI http://activitystrea.ms/schema/1.0/update.
*/
@ -114,46 +129,58 @@ public enum Verb {
/**
*
* <p>
* The "positive RSVP" verb indicates that the actor has made a positive RSVP for the object. This specification only defines the meaning of this verb when
* its object is an event (see <a class='info' href='#event'>Section&nbsp;4.2.1<span> (</span><span class='info'>Event</span><span>)</span></a>), though
* implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications.
* The "positive RSVP" verb indicates that the actor has made a positive RSVP for the object.
* This specification only defines the meaning of this verb when its object is an event (see <a
* class='info' href='#event'>Section&nbsp;4.2.1<span> (</span><span
* class='info'>Event</span><span>)</span></a>), though implementors SHOULD be prepared to
* handle other object types as meaning MAY be provided by extension specifications.
* </p>
* <p>
* The use of this Verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user
* has been added as an attendee by an event organiser or administrator.
* The use of this Verb is only appropriate when the RSVP was created by an explicit action by
* the actor. It is not appropriate to use this verb when a user has been added as an attendee
* by an event organiser or administrator.
* </p>
* <p>
* The verb URI for the "positive RSVP" Verb is <tt>http://activitystrea.ms/schema/1.0/rsvp-yes</tt>.
* The verb URI for the "positive RSVP" Verb is
* <tt>http://activitystrea.ms/schema/1.0/rsvp-yes</tt>.
* </p>
*/
RSVP_YES("http://activitystrea.ms/schema/1.0/rsvp-yes"),
/**
* <p>
* The "possible RSVP" verb indicates that the actor has made a possible RSVP for the object. This specification only defines the meaning of this verb when
* its object is an event (see <a class='info' href='#event'>Section&nbsp;4.2.1<span> (</span><span class='info'>Event</span><span>)</span></a>), though
* implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications.
* The "possible RSVP" verb indicates that the actor has made a possible RSVP for the object.
* This specification only defines the meaning of this verb when its object is an event (see <a
* class='info' href='#event'>Section&nbsp;4.2.1<span> (</span><span
* class='info'>Event</span><span>)</span></a>), though implementors SHOULD be prepared to
* handle other object types as meaning MAY be provided by extension specifications.
* </p>
* <p>
* The use of this Verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user
* has been added as an attendee by an event organiser or administrator.
* The use of this Verb is only appropriate when the RSVP was created by an explicit action by
* the actor. It is not appropriate to use this verb when a user has been added as an attendee
* by an event organiser or administrator.
* </p>
* <p>
* The verb URI for the "possible RSVP" Verb is <tt>http://activitystrea.ms/schema/1.0/rsvp-maybe</tt>.
* The verb URI for the "possible RSVP" Verb is
* <tt>http://activitystrea.ms/schema/1.0/rsvp-maybe</tt>.
* </p>
*/
RSVP_MAYBE("http://activitystrea.ms/schema/1.0/rsvp-maybe"),
/**
* <p>
* The "negative RSVP" verb indicates that the actor has made a negative RSVP for the object. This specification only defines the meaning of this verb when
* its object is an event (see <a class='info' href='#event'>Section&nbsp;4.2.1<span> (</span><span class='info'>Event</span><span>)</span></a>), though
* implementors SHOULD be prepared to handle other object types as meaning MAY be provided by extension specifications.
* The "negative RSVP" verb indicates that the actor has made a negative RSVP for the object.
* This specification only defines the meaning of this verb when its object is an event (see <a
* class='info' href='#event'>Section&nbsp;4.2.1<span> (</span><span
* class='info'>Event</span><span>)</span></a>), though implementors SHOULD be prepared to
* handle other object types as meaning MAY be provided by extension specifications.
* </p>
* <p>
* The use of this Verb is only appropriate when the RSVP was created by an explicit action by the actor. It is not appropriate to use this verb when a user
* has been added as an attendee by an event organiser or administrator.
* The use of this Verb is only appropriate when the RSVP was created by an explicit action by
* the actor. It is not appropriate to use this verb when a user has been added as an attendee
* by an event organiser or administrator.
* </p>
* <p>
* The verb URI for the "negative RSVP" Verb is <tt>http://activitystrea.ms/schema/1.0/rsvp-no</tt>.
* The verb URI for the "negative RSVP" Verb is
* <tt>http://activitystrea.ms/schema/1.0/rsvp-no</tt>.
* </p>
*/
RSVP_NO("http://activitystrea.ms/schema/1.0/rsvp-no");

16
src/main/java/org/rometools/feed/module/activitystreams/types/Video.java
View file

@ -19,10 +19,12 @@ package org.rometools.feed.module.activitystreams.types;
/**
* <p>
* The "video" Object type represents video content, which usually consists of a motion picture track and an audio track.
* The "video" Object type represents video content, which usually consists of a motion picture
* track and an audio track.
* </p>
* <p>
* The "video" Object type is identified by the URI <tt>http://activitystrea.ms/schema/1.0/video</tt>.
* The "video" Object type is identified by the URI
* <tt>http://activitystrea.ms/schema/1.0/video</tt>.
* </p>
* <p>
* A video has the following additional components:
@ -32,11 +34,13 @@ package org.rometools.feed.module.activitystreams.types;
* <blockquote class="text">
* <dl>
* <dt>Video Stream Link</dt>
* <dd>A Media Link Construct linking to the video content itself. Represented in JSON as a property called <tt>stream</tt> whose value is a JSON object with
* properties as defined in [TODO: xref the JSON serialization of a Media Link Construct]</dd>
* <dd>A Media Link Construct linking to the video content itself. Represented in JSON as a property
* called <tt>stream</tt> whose value is a JSON object with properties as defined in [TODO: xref the
* JSON serialization of a Media Link Construct]</dd>
* <dt>Embed Code</dt>
* <dd>An HTML fragment that, when embedded in an HTML page, will provide an interactive player UI for the video stream. Represented in JSON as a property
* called <tt>embedCode</tt> whose value is a JSON string containing the fragment of HTML.</dd>
* <dd>An HTML fragment that, when embedded in an HTML page, will provide an interactive player UI
* for the video stream. Represented in JSON as a property called <tt>embedCode</tt> whose value is
* a JSON string containing the fragment of HTML.</dd>
* </dl>
* </blockquote>
*

37
src/main/java/org/rometools/feed/module/base/Article.java
View file

@ -42,7 +42,8 @@ package org.rometools.feed.module.base;
import java.util.Date;
/**
* This is an interface for the GoogleBase plug in that exposes methods used for Article or News entry types.
* This is an interface for the GoogleBase plug in that exposes methods used for Article or News
* entry types.
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>
* @version $Revision: 1.2 $
@ -54,7 +55,8 @@ public interface Article extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="author"></a>author</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="author"></a>author</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -89,7 +91,8 @@ public interface Article extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="author"></a>author</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="author"></a>author</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -126,7 +129,8 @@ public interface Article extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="news_source"></a>news_source</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="news_source"></a>news_source</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -165,7 +169,8 @@ public interface Article extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="news_source"></a>news_source</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="news_source"></a>news_source</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -204,7 +209,8 @@ public interface Article extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="pages"></a>pages</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="pages"></a>pages</b></font></td>
*
* </tr>
* <tr valign="top">
@ -245,7 +251,8 @@ public interface Article extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="pages"></a>pages</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="pages"></a>pages</b></font></td>
*
* </tr>
* <tr valign="top">
@ -285,15 +292,17 @@ public interface Article extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="publish_date"></a>publish_date</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="publish_date"></a>publish_date</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
*
* <b>Details</b></font></td>
* <td><font size="-1"> Date the item was published in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a> format:
* YYYY-MM-DD</font></td>
* <td><font size="-1"> Date the item was published in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DD</font></td>
*
* </tr>
* <tr valign="top">
@ -329,15 +338,17 @@ public interface Article extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="publish_date"></a>publish_date</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="publish_date"></a>publish_date</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
*
* <b>Details</b></font></td>
* <td><font size="-1"> Date the item was published in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a> format:
* YYYY-MM-DD</font></td>
* <td><font size="-1"> Date the item was published in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DD</font></td>
*
* </tr>
* <tr valign="top">

55
src/main/java/org/rometools/feed/module/base/Course.java
View file

@ -41,7 +41,8 @@ package org.rometools.feed.module.base;
import org.rometools.feed.module.base.types.DateTimeRange;
/**
* This is an interface for the GoogleBase plug in that exposes methods used for Class or Course information entry types.
* This is an interface for the GoogleBase plug in that exposes methods used for Class or Course
* information entry types.
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>
* @version $Revision: 1.2 $
@ -56,12 +57,14 @@ public interface Course extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="course_date_range"></a>course_date_range</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="course_date_range"></a>course_date_range</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1">Date and time range a class is in session, in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO
* 8601</a>. Two sub-attributes are included in course_date_range attribute.
* <td><font size="-1">Date and time range a class is in session, in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>. Two
* sub-attributes are included in course_date_range attribute.
* <ul type="disc">
*
* <li>start = Start date and time of a trip in format YYYY-MM-DDThh:mm:ss</li>
@ -107,12 +110,14 @@ public interface Course extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="course_date_range"></a>course_date_range</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="course_date_range"></a>course_date_range</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1">Date and time range a class is in session, in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO
* 8601</a>. Two sub-attributes are included in course_date_range attribute.
* <td><font size="-1">Date and time range a class is in session, in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>. Two
* sub-attributes are included in course_date_range attribute.
* <ul type="disc">
*
* <li>start = Start date and time of a trip in format YYYY-MM-DDThh:mm:ss</li>
@ -156,7 +161,8 @@ public interface Course extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="course_number"></a>course_number</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="course_number"></a>course_number</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -195,7 +201,8 @@ public interface Course extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="course_number"></a>course_number</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="course_number"></a>course_number</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -233,7 +240,8 @@ public interface Course extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="course_times"></a>course_times</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="course_times"></a>course_times</b></font></td>
*
* </tr>
*
@ -272,7 +280,8 @@ public interface Course extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="course_times"></a>course_times</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="course_times"></a>course_times</b></font></td>
*
* </tr>
*
@ -311,13 +320,15 @@ public interface Course extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="salary"></a>salary</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="salary"></a>salary</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Salary for this position. Non-numeric values such as "$" symbols are not acceptable. </font></td>
* <td><font size="-1"> Salary for this position. Non-numeric values such as "$" symbols are not
* acceptable. </font></td>
* </tr>
* <tr valign="top">
*
@ -354,13 +365,15 @@ public interface Course extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="salary"></a>salary</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="salary"></a>salary</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Salary for this position. Non-numeric values such as "$" symbols are not acceptable. </font></td>
* <td><font size="-1"> Salary for this position. Non-numeric values such as "$" symbols are not
* acceptable. </font></td>
* </tr>
* <tr valign="top">
*
@ -397,7 +410,8 @@ public interface Course extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="subject"></a>subject</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="subject"></a>subject</b></font></td>
* </tr>
* <tr valign="top">
*
@ -436,7 +450,8 @@ public interface Course extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="subject"></a>subject</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="subject"></a>subject</b></font></td>
* </tr>
* <tr valign="top">
*
@ -473,7 +488,8 @@ public interface Course extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="university"></a>university</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="university"></a>university</b></font></td>
*
* </tr>
* <tr valign="top">
@ -512,7 +528,8 @@ public interface Course extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="university"></a>university</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="university"></a>university</b></font></td>
*
* </tr>
* <tr valign="top">

7
src/main/java/org/rometools/feed/module/base/CustomTag.java
View file

@ -92,8 +92,8 @@ public interface CustomTag {
* <tr valign="top">
* <td><font size="-1">dateTimeRange (DateTimeRange)</font></td>
*
* <td><font size="-1">Start and end dates for an event. An attribute of this type will contain two sub-attributes, &lt;start&gt; and &lt;end&gt; in format
* YYYY-MM-DD</font></td>
* <td><font size="-1">Start and end dates for an event. An attribute of this type will contain
* two sub-attributes, &lt;start&gt; and &lt;end&gt; in format YYYY-MM-DD</font></td>
*
* <td><font size="-1">&lt;start&gt;1975-09-25&lt;/start&gt;<br>
* &lt;end&gt;1975-09-25&lt;/end&gt;
@ -123,7 +123,8 @@ public interface CustomTag {
* </tbody>
* </table>
*
* @return The value of the tag. The objects class is determined by the "type" attribute on the tag.
* @return The value of the tag. The objects class is determined by the "type" attribute on the
* tag.
*/
public Object getValue();

49
src/main/java/org/rometools/feed/module/base/CustomTagImpl.java
View file

@ -146,8 +146,9 @@ public class CustomTagImpl implements CustomTag {
}
/**
* Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any
* object <tt>x</tt>, the expression: <blockquote>
* Creates and returns a copy of this object. The precise meaning of "copy" may depend on the
* class of the object. The general intent is that, for any object <tt>x</tt>, the expression:
* <blockquote>
*
* <pre>
* x.clone() != x
@ -159,7 +160,8 @@ public class CustomTagImpl implements CustomTag {
* x.clone().getClass() == x.getClass()
* </pre>
*
* </blockquote> will be <tt>true</tt>, but these are not absolute requirements. While it is typically the case that: <blockquote>
* </blockquote> will be <tt>true</tt>, but these are not absolute requirements. While it is
* typically the case that: <blockquote>
*
* <pre>
* x.clone().equals(x)
@ -167,27 +169,36 @@ public class CustomTagImpl implements CustomTag {
*
* </blockquote> will be <tt>true</tt>, this is not an absolute requirement.
* <p>
* By convention, the returned object should be obtained by calling <tt>super.clone</tt>. If a class and all of its superclasses (except <tt>Object</tt>)
* obey this convention, it will be the case that <tt>x.clone().getClass() == x.getClass()</tt>.
* By convention, the returned object should be obtained by calling <tt>super.clone</tt>. If a
* class and all of its superclasses (except <tt>Object</tt>) obey this convention, it will be
* the case that <tt>x.clone().getClass() == x.getClass()</tt>.
* <p>
* By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be
* necessary to modify one or more fields of the object returned by <tt>super.clone</tt> before returning it. Typically, this means copying any mutable
* objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the
* copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned
* by <tt>super.clone</tt> need to be modified.
* By convention, the object returned by this method should be independent of this object (which
* is being cloned). To achieve this independence, it may be necessary to modify one or more
* fields of the object returned by <tt>super.clone</tt> before returning it. Typically, this
* means copying any mutable objects that comprise the internal "deep structure" of the object
* being cloned and replacing the references to these objects with references to the copies. If
* a class contains only primitive fields or references to immutable objects, then it is usually
* the case that no fields in the object returned by <tt>super.clone</tt> need to be modified.
* <p>
* The method <tt>clone</tt> for class <tt>Object</tt> performs a specific cloning operation. First, if the class of this object does not implement the
* interface <tt>Cloneable</tt>, then a <tt>CloneNotSupportedException</tt> is thrown. Note that all arrays are considered to implement the interface
* <tt>Cloneable</tt>. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of
* the corresponding fields of this object, as if by assignment; the contents of the fields are not themselves cloned. Thus, this method performs a
* "shallow copy" of this object, not a "deep copy" operation.
* The method <tt>clone</tt> for class <tt>Object</tt> performs a specific cloning operation.
* First, if the class of this object does not implement the interface <tt>Cloneable</tt>, then
* a <tt>CloneNotSupportedException</tt> is thrown. Note that all arrays are considered to
* implement the interface <tt>Cloneable</tt>. Otherwise, this method creates a new instance of
* the class of this object and initializes all its fields with exactly the contents of the
* corresponding fields of this object, as if by assignment; the contents of the fields are not
* themselves cloned. Thus, this method performs a "shallow copy" of this object, not a
* "deep copy" operation.
* <p>
* The class <tt>Object</tt> does not itself implement the interface <tt>Cloneable</tt>, so calling the <tt>clone</tt> method on an object whose class is
* <tt>Object</tt> will result in throwing an exception at run time.
* The class <tt>Object</tt> does not itself implement the interface <tt>Cloneable</tt>, so
* calling the <tt>clone</tt> method on an object whose class is <tt>Object</tt> will result in
* throwing an exception at run time.
*
* @return a clone of this instance.
* @exception CloneNotSupportedException if the object's class does not support the <code>Cloneable</code> interface. Subclasses that override the
* <code>clone</code> method can also throw this exception to indicate that an instance cannot be cloned.
* @exception CloneNotSupportedException if the object's class does not support the
* <code>Cloneable</code> interface. Subclasses that override the
* <code>clone</code> method can also throw this exception to indicate that an
* instance cannot be cloned.
* @see java.lang.Cloneable
*/
@Override

194
src/main/java/org/rometools/feed/module/base/Event.java
View file

@ -59,14 +59,16 @@ public interface Event extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -101,14 +103,16 @@ public interface Event extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -143,7 +147,8 @@ public interface Event extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -153,7 +158,8 @@ public interface Event extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -181,7 +187,8 @@ public interface Event extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -191,7 +198,8 @@ public interface Event extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -218,7 +226,8 @@ public interface Event extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -255,7 +264,8 @@ public interface Event extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -293,14 +303,16 @@ public interface Event extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="event_date_range"></a>event_date_range</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="event_date_range"></a>event_date_range</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1">
*
* Information on the date and time an event will take place, in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* Information on the date and time an event will take place, in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format. Two sub-attributes are included in the event_date_range attribute:
* <ul type="disc">
*
@ -344,14 +356,16 @@ public interface Event extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="event_date_range"></a>event_date_range</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="event_date_range"></a>event_date_range</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1">
*
* Information on the date and time an event will take place, in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* Information on the date and time an event will take place, in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format. Two sub-attributes are included in the event_date_range attribute:
* <ul type="disc">
*
@ -395,32 +409,37 @@ public interface Event extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -441,32 +460,37 @@ public interface Event extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -488,14 +512,17 @@ public interface Event extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_accepted"></a>payment_accepted</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_accepted"></a>payment_accepted</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are
* "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
*
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the
* &lt;payment_accepted&gt; attribute for each acceptable method.</font></td>
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one
* method, include multiple instances of the &lt;payment_accepted&gt; attribute for each
* acceptable method.</font></td>
*
* </tr>
*
@ -536,14 +563,17 @@ public interface Event extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_accepted"></a>payment_accepted</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_accepted"></a>payment_accepted</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are
* "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
*
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the
* &lt;payment_accepted&gt; attribute for each acceptable method.</font></td>
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one
* method, include multiple instances of the &lt;payment_accepted&gt; attribute for each
* acceptable method.</font></td>
*
* </tr>
*
@ -583,7 +613,8 @@ public interface Event extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
* </tr>
* <tr valign="top">
*
@ -594,7 +625,8 @@ public interface Event extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -617,7 +649,8 @@ public interface Event extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
* </tr>
* <tr valign="top">
*
@ -628,7 +661,8 @@ public interface Event extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -651,7 +685,8 @@ public interface Event extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
* </tr>
* <tr valign="top">
*
@ -662,7 +697,8 @@ public interface Event extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -690,7 +726,8 @@ public interface Event extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
* </tr>
* <tr valign="top">
*
@ -701,7 +738,8 @@ public interface Event extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -732,14 +770,16 @@ public interface Event extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="price"></a>price</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="price"></a>price</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
*
* <b>Details</b></font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of
* &lt;shipping&gt;, the value included reflects the price of shipping.</font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable.
* Numerice values only. When used as a sub-attribute of &lt;shipping&gt;, the value included
* reflects the price of shipping.</font></td>
*
* </tr>
* <tr valign="top">
@ -784,14 +824,16 @@ public interface Event extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="price"></a>price</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="price"></a>price</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
*
* <b>Details</b></font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of
* &lt;shipping&gt;, the value included reflects the price of shipping.</font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable.
* Numerice values only. When used as a sub-attribute of &lt;shipping&gt;, the value included
* reflects the price of shipping.</font></td>
*
* </tr>
* <tr valign="top">
@ -836,12 +878,14 @@ public interface Event extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="price_type"></a>price_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="price_type"></a>price_type</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are "negotiable," or "starting." The default is "starting"</font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are "negotiable," or
* "starting." The default is "starting"</font></td>
* </tr>
* <tr valign="top">
*
@ -877,12 +921,14 @@ public interface Event extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="price_type"></a>price_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="price_type"></a>price_type</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are "negotiable," or "starting." The default is "starting"</font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are "negotiable," or
* "starting." The default is "starting"</font></td>
* </tr>
* <tr valign="top">
*
@ -917,13 +963,14 @@ public interface Event extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="quantity"></a>quantity</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="quantity"></a>quantity</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not
* applicable. </font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left
* blank if you have a large quantity or if it is not applicable. </font></td>
*
* </tr>
* <tr valign="top">
@ -965,13 +1012,14 @@ public interface Event extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="quantity"></a>quantity</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="quantity"></a>quantity</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not
* applicable. </font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left
* blank if you have a large quantity or if it is not applicable. </font></td>
*
* </tr>
* <tr valign="top">
@ -1020,12 +1068,14 @@ public interface Event extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included
* in the shipping attribute:
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be
* included for each item. Three sub-attributes are included in the shipping attribute:
* <ul type="disc">
*
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166 country codes.</li>
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS',
* 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166
* country codes.</li>
* <li>price = the price of shipping.</li>
* </ul>
* </font></td>
@ -1077,12 +1127,14 @@ public interface Event extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included
* in the shipping attribute:
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be
* included for each item. Three sub-attributes are included in the shipping attribute:
* <ul type="disc">
*
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166 country codes.</li>
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS',
* 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166
* country codes.</li>
* <li>price = the price of shipping.</li>
* </ul>
* </font></td>
@ -1126,7 +1178,8 @@ public interface Event extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="tax_percent"></a>tax_percent</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="tax_percent"></a>tax_percent</b></font></td>
* </tr>
*
* <tr valign="top">
@ -1168,7 +1221,8 @@ public interface Event extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="tax_percent"></a>tax_percent</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="tax_percent"></a>tax_percent</b></font></td>
* </tr>
*
* <tr valign="top">

136
src/main/java/org/rometools/feed/module/base/GlobalInterface.java
View file

@ -56,13 +56,15 @@ public interface GlobalInterface extends Serializable {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="expiration_date"></a>expiration_date</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="expiration_date"></a>expiration_date</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1"> Date that the item expires in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a> format:
* YYYY-MM-DD</font></td>
* <td><font size="-1"> Date that the item expires in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DD</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -72,7 +74,8 @@ public interface GlobalInterface extends Serializable {
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, People profiles, Products,
* Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Content type</b></font></td>
@ -92,13 +95,15 @@ public interface GlobalInterface extends Serializable {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="expiration_date"></a>expiration_date</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="expiration_date"></a>expiration_date</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1"> Date that the item expires in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a> format:
* YYYY-MM-DD</font></td>
* <td><font size="-1"> Date that the item expires in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DD</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -108,7 +113,8 @@ public interface GlobalInterface extends Serializable {
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, People profiles, Products,
* Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Content type</b></font></td>
@ -128,24 +134,28 @@ public interface GlobalInterface extends Serializable {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="expiration_date_time"></a>expiration_date_time</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="expiration_date_time"></a>expiration_date_time</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1"> Date and time that the item expires in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* <td><font size="-1"> Date and time that the item expires in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DDThh:mm:ss</font></td>
* </tr>
*
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:expiration_date_time&gt;12-20-05T11:59:59&lt;/g:expiration_date_time&gt; </font></td>
* <td><font size="-1">
* &lt;g:expiration_date_time&gt;12-20-05T11:59:59&lt;/g:expiration_date_time&gt; </font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Attribute of</b></font></td>
*
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, People profiles, Products,
* Services, Travel, Vehicles, Wanted Ads.</font></td>
*
* </tr>
* <tr valign="top">
@ -166,24 +176,28 @@ public interface GlobalInterface extends Serializable {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="expiration_date_time"></a>expiration_date_time</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="expiration_date_time"></a>expiration_date_time</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1"> Date and time that the item expires in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* <td><font size="-1"> Date and time that the item expires in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DDThh:mm:ss</font></td>
* </tr>
*
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:expiration_date_time&gt;12-20-05T11:59:59&lt;/g:expiration_date_time&gt; </font></td>
* <td><font size="-1">
* &lt;g:expiration_date_time&gt;12-20-05T11:59:59&lt;/g:expiration_date_time&gt; </font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Attribute of</b></font></td>
*
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, People profiles, Products,
* Services, Travel, Vehicles, Wanted Ads.</font></td>
*
* </tr>
* <tr valign="top">
@ -203,14 +217,17 @@ public interface GlobalInterface extends Serializable {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="id"></a>id</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="id"></a>id</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1"> Unique alphanumeric identifier for each item - e.g., your internal ID code.<br>
* IMPORTANT: Once you submit an item with a unique id, this identifier must not change when you send in a new bulk upload. Each item must retain the same
* id in subsequent bulk uploads.</font></td>
* <td><font size="-1"> Unique alphanumeric identifier for each item - e.g., your internal ID
* code.<br>
* IMPORTANT: Once you submit an item with a unique id, this identifier must not change when you
* send in a new bulk upload. Each item must retain the same id in subsequent bulk
* uploads.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -220,8 +237,8 @@ public interface GlobalInterface extends Serializable {
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
*
* </tr>
*
@ -241,14 +258,17 @@ public interface GlobalInterface extends Serializable {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="id"></a>id</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="id"></a>id</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1"> Unique alphanumeric identifier for each item - e.g., your internal ID code.<br>
* IMPORTANT: Once you submit an item with a unique id, this identifier must not change when you send in a new bulk upload. Each item must retain the same
* id in subsequent bulk uploads.</font></td>
* <td><font size="-1"> Unique alphanumeric identifier for each item - e.g., your internal ID
* code.<br>
* IMPORTANT: Once you submit an item with a unique id, this identifier must not change when you
* send in a new bulk upload. Each item must retain the same id in subsequent bulk
* uploads.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -258,8 +278,8 @@ public interface GlobalInterface extends Serializable {
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
*
* </tr>
*
@ -280,14 +300,17 @@ public interface GlobalInterface extends Serializable {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="image_link"></a>image_link</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="image_link"></a>image_link</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1"> URL of an associated image if available online. Use your full-sized images; do not use thumbnail images. Up to ten image_links, all
* placed in between their own &lt;image_link&gt; and &lt;/image_link&gt; attributes, can be included with each item. If you do not have an image available,
* do not include this attribute. Please do not include an image that says "Image not available." Relative URLs and logo images are not acceptable.</font></td>
* <td><font size="-1"> URL of an associated image if available online. Use your full-sized
* images; do not use thumbnail images. Up to ten image_links, all placed in between their own
* &lt;image_link&gt; and &lt;/image_link&gt; attributes, can be included with each item. If you
* do not have an image available, do not include this attribute. Please do not include an image
* that says "Image not available." Relative URLs and logo images are not acceptable.</font></td>
*
* </tr>
* <tr valign="top">
@ -305,8 +328,8 @@ public interface GlobalInterface extends Serializable {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Attribute of</b></font></td>
*
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Content type</b></font></td>
@ -327,14 +350,17 @@ public interface GlobalInterface extends Serializable {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="image_link"></a>image_link</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="image_link"></a>image_link</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1"> URL of an associated image if available online. Use your full-sized images; do not use thumbnail images. Up to ten image_links, all
* placed in between their own &lt;image_link&gt; and &lt;/image_link&gt; attributes, can be included with each item. If you do not have an image available,
* do not include this attribute. Please do not include an image that says "Image not available." Relative URLs and logo images are not acceptable.</font></td>
* <td><font size="-1"> URL of an associated image if available online. Use your full-sized
* images; do not use thumbnail images. Up to ten image_links, all placed in between their own
* &lt;image_link&gt; and &lt;/image_link&gt; attributes, can be included with each item. If you
* do not have an image available, do not include this attribute. Please do not include an image
* that says "Image not available." Relative URLs and logo images are not acceptable.</font></td>
*
* </tr>
* <tr valign="top">
@ -352,8 +378,8 @@ public interface GlobalInterface extends Serializable {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Attribute of</b></font></td>
*
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Content type</b></font></td>
@ -383,10 +409,12 @@ public interface GlobalInterface extends Serializable {
*
* <font size="-1"><b>Details</b></font></td>
* <td>
* <font size="-1">A list of classifications the item may fall under. Up to ten user-selected label, each placed in between their own &lt;label&gt;
* <font size="-1">A list of classifications the item may fall under. Up to ten user-selected
* label, each placed in between their own &lt;label&gt;
*
* and &lt;/label&gt; tags, can be included with each item. These attributes will be used to match your items to search queries. Each attribute value will
* be checked for policy compliance.</font></td>
* and &lt;/label&gt; tags, can be included with each item. These attributes will be used to
* match your items to search queries. Each attribute value will be checked for policy
* compliance.</font></td>
* </tr>
*
* <tr valign="top">
@ -419,15 +447,16 @@ public interface GlobalInterface extends Serializable {
* <br>
* </font> <font size="-1"><em>Not acceptable:</em><br>
*
* </font> <font size="-1">&lt;g:label&gt; leater, power locks, sunroof, ABS &lt;/g:label&gt;</font></td>
* </font> <font size="-1">&lt;g:label&gt; leater, power locks, sunroof, ABS
* &lt;/g:label&gt;</font></td>
* </tr>
* <tr valign="top">
* <td width="120">
* <font size="-1"><b>Attribute of</b></font></td>
*
* <td>
* <font size="-1">Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <font size="-1">Reference Items, Events, Housing, Jobs, News and Articles, People profiles,
* Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
* <tr valign="top">
* <td width="120">
@ -459,10 +488,12 @@ public interface GlobalInterface extends Serializable {
*
* <font size="-1"><b>Details</b></font></td>
* <td>
* <font size="-1">A list of classifications the item may fall under. Up to ten user-selected label, each placed in between their own &lt;label&gt;
* <font size="-1">A list of classifications the item may fall under. Up to ten user-selected
* label, each placed in between their own &lt;label&gt;
*
* and &lt;/label&gt; tags, can be included with each item. These attributes will be used to match your items to search queries. Each attribute value will
* be checked for policy compliance.</font></td>
* and &lt;/label&gt; tags, can be included with each item. These attributes will be used to
* match your items to search queries. Each attribute value will be checked for policy
* compliance.</font></td>
* </tr>
*
* <tr valign="top">
@ -495,15 +526,16 @@ public interface GlobalInterface extends Serializable {
* <br>
* </font> <font size="-1"><em>Not acceptable:</em><br>
*
* </font> <font size="-1">&lt;g:label&gt; leater, power locks, sunroof, ABS &lt;/g:label&gt;</font></td>
* </font> <font size="-1">&lt;g:label&gt; leater, power locks, sunroof, ABS
* &lt;/g:label&gt;</font></td>
* </tr>
* <tr valign="top">
* <td width="120">
* <font size="-1"><b>Attribute of</b></font></td>
*
* <td>
* <font size="-1">Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <font size="-1">Reference Items, Events, Housing, Jobs, News and Articles, People profiles,
* Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
* <tr valign="top">
* <td width="120">

5
src/main/java/org/rometools/feed/module/base/GoogleBase.java
View file

@ -45,8 +45,9 @@ import com.sun.syndication.feed.module.Module;
* This is the root interface for the Google Base module.
*
* <p>
* It supports all the individual data "types". If you want to work with, for instance, just the Article or Job datatype, you can cast it to the respective
* interface and see only methods related to a particular entry type.
* It supports all the individual data "types". If you want to work with, for instance, just the
* Article or Job datatype, you can cast it to the respective interface and see only methods related
* to a particular entry type.
* </p>
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>

189
src/main/java/org/rometools/feed/module/base/Housing.java
View file

@ -47,7 +47,8 @@ import org.rometools.feed.module.base.types.PriceTypeEnumeration;
import org.rometools.feed.module.base.types.YearType;
/**
* This is an interface for the GoogleBase plug in that exposes methods used for Housing entry types.
* This is an interface for the GoogleBase plug in that exposes methods used for Housing entry
* types.
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>
* @version $Revision: 1.1 $
@ -58,7 +59,8 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr bgcolor="#dddddd" valign="top">
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a name="agent"></a>agent</strong></font></td>
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a
* name="agent"></a>agent</strong></font></td>
*
* </tr>
* <tr valign="top">
@ -94,7 +96,8 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr bgcolor="#dddddd" valign="top">
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a name="agent"></a>agent</strong></font></td>
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a
* name="agent"></a>agent</strong></font></td>
*
* </tr>
* <tr valign="top">
@ -132,7 +135,8 @@ public interface Housing extends GlobalInterface {
*
* <tbody>
* <tr bgcolor="#dddddd" valign="top">
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a name="area"></a>area</strong></font></td>
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a
* name="area"></a>area</strong></font></td>
* </tr>
* <tr valign="top">
*
@ -169,7 +173,8 @@ public interface Housing extends GlobalInterface {
*
* <tbody>
* <tr bgcolor="#dddddd" valign="top">
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a name="area"></a>area</strong></font></td>
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a
* name="area"></a>area</strong></font></td>
* </tr>
* <tr valign="top">
*
@ -205,7 +210,8 @@ public interface Housing extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="bathrooms"></a>bathrooms</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="bathrooms"></a>bathrooms</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
@ -250,7 +256,8 @@ public interface Housing extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="bathrooms"></a>bathrooms</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="bathrooms"></a>bathrooms</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
@ -294,7 +301,8 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="bedrooms"></a>bedrooms</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="bedrooms"></a>bedrooms</b></font></td>
*
* </tr>
* <tr valign="top">
@ -335,7 +343,8 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="bedrooms"></a>bedrooms</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="bedrooms"></a>bedrooms</b></font></td>
*
* </tr>
* <tr valign="top">
@ -376,14 +385,16 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -418,14 +429,16 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -460,7 +473,8 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="hoa_dues"></a>hoa_dues</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="hoa_dues"></a>hoa_dues</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -497,7 +511,8 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="hoa_dues"></a>hoa_dues</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="hoa_dues"></a>hoa_dues</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -536,13 +551,15 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="listing_type"></a>listing_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="listing_type"></a>listing_type</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1"> Information about whether or not a property is for sale or not. Acceptable values are "True" or "False".</font></td>
* <td><font size="-1"> Information about whether or not a property is for sale or not.
* Acceptable values are "True" or "False".</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -583,13 +600,15 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="listing_type"></a>listing_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="listing_type"></a>listing_type</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1"> Information about whether or not a property is for sale or not. Acceptable values are "True" or "False".</font></td>
* <td><font size="-1"> Information about whether or not a property is for sale or not.
* Acceptable values are "True" or "False".</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -628,32 +647,37 @@ public interface Housing extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -674,32 +698,37 @@ public interface Housing extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -721,14 +750,17 @@ public interface Housing extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_accepted"></a>payment_accepted</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_accepted"></a>payment_accepted</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are
* "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
*
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the
* &lt;payment_accepted&gt; attribute for each acceptable method.</font></td>
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one
* method, include multiple instances of the &lt;payment_accepted&gt; attribute for each
* acceptable method.</font></td>
*
* </tr>
*
@ -769,14 +801,17 @@ public interface Housing extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_accepted"></a>payment_accepted</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_accepted"></a>payment_accepted</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are
* "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
*
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the
* &lt;payment_accepted&gt; attribute for each acceptable method.</font></td>
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one
* method, include multiple instances of the &lt;payment_accepted&gt; attribute for each
* acceptable method.</font></td>
*
* </tr>
*
@ -816,7 +851,8 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
* </tr>
* <tr valign="top">
*
@ -827,7 +863,8 @@ public interface Housing extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -855,7 +892,8 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
* </tr>
* <tr valign="top">
*
@ -866,7 +904,8 @@ public interface Housing extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -896,12 +935,14 @@ public interface Housing extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="price"></a>price</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="price"></a>price</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of
* &lt;shipping&gt;, the value included reflects the price of shipping.</font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable.
* Numerice values only. When used as a sub-attribute of &lt;shipping&gt;, the value included
* reflects the price of shipping.</font></td>
*
* </tr>
* <tr valign="top">
@ -942,12 +983,14 @@ public interface Housing extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="price"></a>price</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="price"></a>price</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of
* &lt;shipping&gt;, the value included reflects the price of shipping.</font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable.
* Numerice values only. When used as a sub-attribute of &lt;shipping&gt;, the value included
* reflects the price of shipping.</font></td>
*
* </tr>
* <tr valign="top">
@ -987,13 +1030,15 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="price_type"></a>price_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="price_type"></a>price_type</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are <EFBFBD>negotiable,<EFBFBD> or <EFBFBD>starting.<EFBFBD> The default is <EFBFBD>starting<EFBFBD></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are <EFBFBD>negotiable,<EFBFBD> or
* <EFBFBD>starting.<EFBFBD> The default is <EFBFBD>starting<EFBFBD></font></td>
* </tr>
* <tr valign="top">
*
@ -1029,13 +1074,15 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="price_type"></a>price_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="price_type"></a>price_type</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are <EFBFBD>negotiable,<EFBFBD> or <EFBFBD>starting.<EFBFBD> The default is <EFBFBD>starting<EFBFBD></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are <EFBFBD>negotiable,<EFBFBD> or
* <EFBFBD>starting.<EFBFBD> The default is <EFBFBD>starting<EFBFBD></font></td>
* </tr>
* <tr valign="top">
*
@ -1070,7 +1117,8 @@ public interface Housing extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="property_type"></a>property_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="property_type"></a>property_type</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
@ -1111,7 +1159,8 @@ public interface Housing extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="property_type"></a>property_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="property_type"></a>property_type</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
@ -1153,7 +1202,8 @@ public interface Housing extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="school_district"></a>school_district</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="school_district"></a>school_district</b></font></td>
* </tr>
*
* <tr valign="top">
@ -1164,8 +1214,8 @@ public interface Housing extends GlobalInterface {
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Example</b></font></td>
* <td><font size="-1"> &lt;g:school_district&gt;<st1:place><st1:placename>Union</st1:placename> <st1:placetype>School
* District</st1:placetype></st1:place>&lt;/g:school_district&gt;</font></td>
* <td><font size="-1"> &lt;g:school_district&gt;<st1:place><st1:placename>Union</st1:placename>
* <st1:placetype>School District</st1:placetype></st1:place>&lt;/g:school_district&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -1194,7 +1244,8 @@ public interface Housing extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="school_district"></a>school_district</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="school_district"></a>school_district</b></font></td>
* </tr>
*
* <tr valign="top">
@ -1205,8 +1256,8 @@ public interface Housing extends GlobalInterface {
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Example</b></font></td>
* <td><font size="-1"> &lt;g:school_district&gt;<st1:place><st1:placename>Union</st1:placename> <st1:placetype>School
* District</st1:placetype></st1:place>&lt;/g:school_district&gt;</font></td>
* <td><font size="-1"> &lt;g:school_district&gt;<st1:place><st1:placename>Union</st1:placename>
* <st1:placetype>School District</st1:placetype></st1:place>&lt;/g:school_district&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -1233,7 +1284,8 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="tax_percent"></a>tax_percent</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="tax_percent"></a>tax_percent</b></font></td>
* </tr>
*
* <tr valign="top">
@ -1274,7 +1326,8 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="tax_percent"></a>tax_percent</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="tax_percent"></a>tax_percent</b></font></td>
* </tr>
*
* <tr valign="top">
@ -1398,7 +1451,8 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="year"></a>year</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="year"></a>year</b></font></td>
* </tr>
* <tr valign="top">
*
@ -1444,7 +1498,8 @@ public interface Housing extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="year"></a>year</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="year"></a>year</b></font></td>
* </tr>
* <tr valign="top">
*

122
src/main/java/org/rometools/feed/module/base/Job.java
View file

@ -43,7 +43,8 @@ import org.rometools.feed.module.base.types.CurrencyEnumeration;
import org.rometools.feed.module.base.types.PriceTypeEnumeration;
/**
* This is an interface for the GoogleBase plug in that exposes methods used for Job listing entry types.
* This is an interface for the GoogleBase plug in that exposes methods used for Job listing entry
* types.
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>
* @version $Revision: 1.1 $
@ -54,7 +55,8 @@ public interface Job extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="education"></a>education</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="education"></a>education</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -87,7 +89,8 @@ public interface Job extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="education"></a>education</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="education"></a>education</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -120,7 +123,8 @@ public interface Job extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="employer"></a>employer</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="employer"></a>employer</b></font></td>
*
* </tr>
* <tr valign="top">
@ -153,7 +157,8 @@ public interface Job extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="employer"></a>employer</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="employer"></a>employer</b></font></td>
*
* </tr>
* <tr valign="top">
@ -187,7 +192,8 @@ public interface Job extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="immigration_status"></a>immigration_status</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="immigration_status"></a>immigration_status</b></font></td>
*
* </tr>
* <tr valign="top">
@ -198,7 +204,8 @@ public interface Job extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
*
* <td><font size="-1">&lt;g:immigration_status&gt;Permanent resident&lt;/g:immigration_status&gt;</font></td>
* <td><font size="-1">&lt;g:immigration_status&gt;Permanent
* resident&lt;/g:immigration_status&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -224,7 +231,8 @@ public interface Job extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="immigration_status"></a>immigration_status</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="immigration_status"></a>immigration_status</b></font></td>
*
* </tr>
* <tr valign="top">
@ -235,7 +243,8 @@ public interface Job extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
*
* <td><font size="-1">&lt;g:immigration_status&gt;Permanent resident&lt;/g:immigration_status&gt;</font></td>
* <td><font size="-1">&lt;g:immigration_status&gt;Permanent
* resident&lt;/g:immigration_status&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -262,7 +271,8 @@ public interface Job extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="job_function"></a>job_function</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="job_function"></a>job_function</b></font></td>
* </tr>
*
* <tr valign="top">
@ -303,7 +313,8 @@ public interface Job extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="job_function"></a>job_function</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="job_function"></a>job_function</b></font></td>
* </tr>
*
* <tr valign="top">
@ -419,12 +430,14 @@ public interface Job extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="job_type"></a>job_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="job_type"></a>job_type</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Type of employment position. Example: Full-time, part-time, contractor, etc.</font></td>
* <td><font size="-1"> Type of employment position. Example: Full-time, part-time, contractor,
* etc.</font></td>
*
* </tr>
* <tr valign="top">
@ -457,12 +470,14 @@ public interface Job extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="job_type"></a>job_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="job_type"></a>job_type</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Type of employment position. Example: Full-time, part-time, contractor, etc.</font></td>
* <td><font size="-1"> Type of employment position. Example: Full-time, part-time, contractor,
* etc.</font></td>
*
* </tr>
* <tr valign="top">
@ -495,32 +510,37 @@ public interface Job extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -541,32 +561,37 @@ public interface Job extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -586,13 +611,15 @@ public interface Job extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="salary"></a>salary</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="salary"></a>salary</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Salary for this position. Non-numeric values such as "$" symbols are not acceptable. </font></td>
* <td><font size="-1"> Salary for this position. Non-numeric values such as "$" symbols are not
* acceptable. </font></td>
* </tr>
* <tr valign="top">
*
@ -618,7 +645,8 @@ public interface Job extends GlobalInterface {
* </tbody>
* </table>
*
* @param salary Salary for this position. Non-numeric values such as "$" symbols are not acceptable.
* @param salary Salary for this position. Non-numeric values such as "$" symbols are not
* acceptable.
*/
public void setSalary(Float salary);
@ -627,13 +655,15 @@ public interface Job extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="salary"></a>salary</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="salary"></a>salary</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Salary for this position. Non-numeric values such as "$" symbols are not acceptable. </font></td>
* <td><font size="-1"> Salary for this position. Non-numeric values such as "$" symbols are not
* acceptable. </font></td>
* </tr>
* <tr valign="top">
*
@ -668,13 +698,15 @@ public interface Job extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="salary_type"></a>salary_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="salary_type"></a>salary_type</b></font></td>
*
* </tr>
*
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> The type of salary included. Accepted values are <EFBFBD>starting<EFBFBD> or <EFBFBD>negotiable;<EFBFBD> The default is <EFBFBD>starting at.<EFBFBD></font></td>
* <td><font size="-1"> The type of salary included. Accepted values are <EFBFBD>starting<EFBFBD> or
* <EFBFBD>negotiable;<EFBFBD> The default is <EFBFBD>starting at.<EFBFBD></font></td>
*
* </tr>
* <tr valign="top">
@ -709,13 +741,15 @@ public interface Job extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="salary_type"></a>salary_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="salary_type"></a>salary_type</b></font></td>
*
* </tr>
*
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> The type of salary included. Accepted values are <EFBFBD>starting<EFBFBD> or <EFBFBD>negotiable;<EFBFBD> The default is <EFBFBD>starting at.<EFBFBD></font></td>
* <td><font size="-1"> The type of salary included. Accepted values are <EFBFBD>starting<EFBFBD> or
* <EFBFBD>negotiable;<EFBFBD> The default is <EFBFBD>starting at.<EFBFBD></font></td>
*
* </tr>
* <tr valign="top">
@ -751,14 +785,16 @@ public interface Job extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -793,14 +829,16 @@ public interface Job extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>

145
src/main/java/org/rometools/feed/module/base/Person.java
View file

@ -42,7 +42,8 @@ package org.rometools.feed.module.base;
import org.rometools.feed.module.base.types.GenderEnumeration;
/**
* This is an interface for the GoogleBase plug in that exposes methods used for Person (personal ad, resume, profile) entry types.
* This is an interface for the GoogleBase plug in that exposes methods used for Person (personal
* ad, resume, profile) entry types.
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>
* @version $Revision: 1.2 $
@ -53,11 +54,13 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr bgcolor="#dddddd" valign="top">
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a name="age"></a>age</strong></font></td>
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a name="age"></a>age</strong></font>
* </td>
* </tr>
* <tr valign="top">
* <td width="120"><strong><font size="-1">Details</font></strong></td>
* <td><font size="-1">Minimum age requirement for the event or the age of the individual in a People profiles bulk upload entry.</font></td>
* <td><font size="-1">Minimum age requirement for the event or the age of the individual in a
* People profiles bulk upload entry.</font></td>
*
* </tr>
* <tr valign="top">
@ -90,11 +93,13 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr bgcolor="#dddddd" valign="top">
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a name="age"></a>age</strong></font></td>
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a name="age"></a>age</strong></font>
* </td>
* </tr>
* <tr valign="top">
* <td width="120"><strong><font size="-1">Details</font></strong></td>
* <td><font size="-1">Minimum age requirement for the event or the age of the individual in a People profiles bulk upload entry.</font></td>
* <td><font size="-1">Minimum age requirement for the event or the age of the individual in a
* People profiles bulk upload entry.</font></td>
*
* </tr>
* <tr valign="top">
@ -127,7 +132,8 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="education"></a>education</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="education"></a>education</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -160,7 +166,8 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="education"></a>education</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="education"></a>education</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -194,7 +201,8 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="employer"></a>employer</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="employer"></a>employer</b></font></td>
*
* </tr>
* <tr valign="top">
@ -228,7 +236,8 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="employer"></a>employer</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="employer"></a>employer</b></font></td>
*
* </tr>
* <tr valign="top">
@ -262,12 +271,14 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="ethnicity"></a>ethnicity</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="ethnicity"></a>ethnicity</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1"> Ethnicity of the individual in the People profiles bulk upload entry.</font></td>
* <td><font size="-1"> Ethnicity of the individual in the People profiles bulk upload
* entry.</font></td>
*
* </tr>
* <tr valign="top">
@ -299,12 +310,14 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="ethnicity"></a>ethnicity</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="ethnicity"></a>ethnicity</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1"> Ethnicity of the individual in the People profiles bulk upload entry.</font></td>
* <td><font size="-1"> Ethnicity of the individual in the People profiles bulk upload
* entry.</font></td>
*
* </tr>
* <tr valign="top">
@ -336,13 +349,15 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="gender"></a>gender</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="gender"></a>gender</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1"> Gender of an individual in a People profiles bulk upload item. Acceptable values are <EFBFBD>Male<EFBFBD>, <EFBFBD>M<EFBFBD>, <EFBFBD>Female<EFBFBD>, or <EFBFBD>F<EFBFBD>.</font></td>
* <td><font size="-1"> Gender of an individual in a People profiles bulk upload item.
* Acceptable values are <EFBFBD>Male<EFBFBD>, <EFBFBD>M<EFBFBD>, <EFBFBD>Female<EFBFBD>, or <EFBFBD>F<EFBFBD>.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -371,13 +386,15 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="gender"></a>gender</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="gender"></a>gender</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1"> Gender of an individual in a People profiles bulk upload item. Acceptable values are <EFBFBD>Male<EFBFBD>, <EFBFBD>M<EFBFBD>, <EFBFBD>Female<EFBFBD>, or <EFBFBD>F<EFBFBD>.</font></td>
* <td><font size="-1"> Gender of an individual in a People profiles bulk upload item.
* Acceptable values are <EFBFBD>Male<EFBFBD>, <EFBFBD>M<EFBFBD>, <EFBFBD>Female<EFBFBD>, or <EFBFBD>F<EFBFBD>.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -406,7 +423,8 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="interested_in"></a>interested_in</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="interested_in"></a>interested_in</b></font></td>
*
* </tr>
* <tr valign="top">
@ -417,7 +435,8 @@ public interface Person extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:interested_in&gt;Long walks on the beach.&lt;/g:interested_in&gt;</font></td>
* <td><font size="-1"> &lt;g:interested_in&gt;Long walks on the
* beach.&lt;/g:interested_in&gt;</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Attribute of</b></font></td>
@ -443,7 +462,8 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="interested_in"></a>interested_in</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="interested_in"></a>interested_in</b></font></td>
*
* </tr>
* <tr valign="top">
@ -454,7 +474,8 @@ public interface Person extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:interested_in&gt;Long walks on the beach.&lt;/g:interested_in&gt;</font></td>
* <td><font size="-1"> &lt;g:interested_in&gt;Long walks on the
* beach.&lt;/g:interested_in&gt;</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Attribute of</b></font></td>
@ -480,32 +501,37 @@ public interface Person extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -526,32 +552,37 @@ public interface Person extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -573,14 +604,15 @@ public interface Person extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="marital_status"></a>marital_status</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="marital_status"></a>marital_status</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
*
* <b>Details</b></font></td>
* <td><font size="-1"> Marital status of an individual in a People profiles bulk upload entry. For example -single, divorced, separated, widowed, married,
* and <EFBFBD>in relationship.<EFBFBD></font></td>
* <td><font size="-1"> Marital status of an individual in a People profiles bulk upload entry.
* For example -single, divorced, separated, widowed, married, and <EFBFBD>in relationship.<EFBFBD></font></td>
*
* </tr>
* <tr valign="top">
@ -618,14 +650,15 @@ public interface Person extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="marital_status"></a>marital_status</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="marital_status"></a>marital_status</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
*
* <b>Details</b></font></td>
* <td><font size="-1"> Marital status of an individual in a People profiles bulk upload entry. For example -single, divorced, separated, widowed, married,
* and <EFBFBD>in relationship.<EFBFBD></font></td>
* <td><font size="-1"> Marital status of an individual in a People profiles bulk upload entry.
* For example -single, divorced, separated, widowed, married, and <EFBFBD>in relationship.<EFBFBD></font></td>
*
* </tr>
* <tr valign="top">
@ -663,13 +696,15 @@ public interface Person extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="occupation"></a>occupation</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="occupation"></a>occupation</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
*
* <b>Details</b></font></td>
* <td><font size="-1"> Industry the individual in a People profiles bulk upload is employed in.</font></td>
* <td><font size="-1"> Industry the individual in a People profiles bulk upload is employed
* in.</font></td>
*
* </tr>
* <tr valign="top">
@ -705,13 +740,15 @@ public interface Person extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="occupation"></a>occupation</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="occupation"></a>occupation</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
*
* <b>Details</b></font></td>
* <td><font size="-1"> Industry the individual in a People profiles bulk upload is employed in.</font></td>
* <td><font size="-1"> Industry the individual in a People profiles bulk upload is employed
* in.</font></td>
*
* </tr>
* <tr valign="top">
@ -746,19 +783,22 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="sexual_orientation"></a>sexual_orientation</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="sexual_orientation"></a>sexual_orientation</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
*
* <b>Details</b></font></td>
*
* <td><font size="-1"> Sexual orientation of an individual in a People profiles information type..</font></td>
* <td><font size="-1"> Sexual orientation of an individual in a People profiles information
* type..</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:sexual_orientation&gt;straight&lt;/g:sexual_orientation&gt;</font></td>
* <td><font size="-1"> &lt;g:sexual_orientation&gt;straight&lt;/g:sexual_orientation&gt;</font>
* </td>
*
* </tr>
* <tr valign="top">
@ -786,19 +826,22 @@ public interface Person extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="sexual_orientation"></a>sexual_orientation</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="sexual_orientation"></a>sexual_orientation</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
*
* <b>Details</b></font></td>
*
* <td><font size="-1"> Sexual orientation of an individual in a People profiles information type..</font></td>
* <td><font size="-1"> Sexual orientation of an individual in a People profiles information
* type..</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:sexual_orientation&gt;straight&lt;/g:sexual_orientation&gt;</font></td>
* <td><font size="-1"> &lt;g:sexual_orientation&gt;straight&lt;/g:sexual_orientation&gt;</font>
* </td>
*
* </tr>
* <tr valign="top">

284
src/main/java/org/rometools/feed/module/base/Product.java
View file

@ -60,7 +60,8 @@ public interface Product extends GlobalInterface {
* <tbody>
* <tr bgcolor="#dddddd" valign="top">
*
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a name="actor"></a>actor</strong></font></td>
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a
* name="actor"></a>actor</strong></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><strong><font size="-1">Details</font></strong></td>
@ -96,7 +97,8 @@ public interface Product extends GlobalInterface {
* <tbody>
* <tr bgcolor="#dddddd" valign="top">
*
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a name="actor"></a>actor</strong></font></td>
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a
* name="actor"></a>actor</strong></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><strong><font size="-1">Details</font></strong></td>
@ -132,7 +134,8 @@ public interface Product extends GlobalInterface {
* <tbody>
* <tr bgcolor="#dddddd" valign="top">
*
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a name="apparel_type"></a>apparel_type</strong></font></td>
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a
* name="apparel_type"></a>apparel_type</strong></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><strong><font size="-1">Details</font></strong></td>
@ -169,7 +172,8 @@ public interface Product extends GlobalInterface {
* <tbody>
* <tr bgcolor="#dddddd" valign="top">
*
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a name="apparel_type"></a>apparel_type</strong></font></td>
* <td colspan="2" nowrap="nowrap"><font size="-1"><strong><a
* name="apparel_type"></a>apparel_type</strong></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><strong><font size="-1">Details</font></strong></td>
@ -204,7 +208,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="artist"></a>artist</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="artist"></a>artist</b></font></td>
*
* </tr>
* <tr valign="top">
@ -242,7 +247,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="artist"></a>artist</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="artist"></a>artist</b></font></td>
*
* </tr>
* <tr valign="top">
@ -282,7 +288,8 @@ public interface Product extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="author"></a>author</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="author"></a>author</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -318,7 +325,8 @@ public interface Product extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="author"></a>author</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="author"></a>author</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -352,7 +360,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="brand"></a>brand</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="brand"></a>brand</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -386,7 +395,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="brand"></a>brand</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="brand"></a>brand</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -422,7 +432,8 @@ public interface Product extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="color"></a>color</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="color"></a>color</b></font></td>
*
* </tr>
* <tr valign="top">
@ -462,7 +473,8 @@ public interface Product extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="color"></a>color</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="color"></a>color</b></font></td>
*
* </tr>
* <tr valign="top">
@ -501,7 +513,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="condition"></a>condition</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="condition"></a>condition</b></font></td>
*
* </tr>
* <tr valign="top">
@ -539,7 +552,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="condition"></a>condition</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="condition"></a>condition</b></font></td>
*
* </tr>
* <tr valign="top">
@ -577,14 +591,16 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -619,14 +635,16 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -661,7 +679,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -671,7 +690,8 @@ public interface Product extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -698,7 +718,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -708,7 +729,8 @@ public interface Product extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -735,7 +757,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -772,7 +795,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -809,7 +833,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="format"></a>format</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="format"></a>format</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -846,7 +871,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="format"></a>format</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="format"></a>format</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -883,7 +909,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="isbn"></a>isbn</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="isbn"></a>isbn</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -918,7 +945,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="isbn"></a>isbn</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="isbn"></a>isbn</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -949,37 +977,43 @@ public interface Product extends GlobalInterface {
public String getIsbn();
/**
* Location of a property. Should include street, city, state, postal code, and country, in that order.
* Location of a property. Should include street, city, state, postal code, and country, in that
* order.
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -990,42 +1024,49 @@ public interface Product extends GlobalInterface {
* </tbody>
* </table>
*
* @param location Location of a property. Should include street, city, state, postal code, and country, in that order.
* @param location Location of a property. Should include street, city, state, postal code, and
* country, in that order.
*/
public void setLocation(String location);
/**
* Location of a property. Should include street, city, state, postal code, and country, in that order.
* Location of a property. Should include street, city, state, postal code, and country, in that
* order.
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -1036,7 +1077,8 @@ public interface Product extends GlobalInterface {
* </tbody>
* </table>
*
* @return Location of a property. Should include street, city, state, postal code, and country, in that order.
* @return Location of a property. Should include street, city, state, postal code, and country,
* in that order.
*/
public String getLocation();
@ -1141,7 +1183,8 @@ public interface Product extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="manufacturer_id"></a>manufacturer_id</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="manufacturer_id"></a>manufacturer_id</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -1178,7 +1221,8 @@ public interface Product extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="manufacturer_id"></a>manufacturer_id</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="manufacturer_id"></a>manufacturer_id</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -1374,7 +1418,8 @@ public interface Product extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="model_number"></a>model_number</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="model_number"></a>model_number</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -1412,7 +1457,8 @@ public interface Product extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="model_number"></a>model_number</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="model_number"></a>model_number</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -1449,14 +1495,17 @@ public interface Product extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_accepted"></a>payment_accepted</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_accepted"></a>payment_accepted</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,”
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are
* “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,”
*
* “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method, include multiple instances of the &lt;payment_accepted&gt;
* attribute for each acceptable method.</font></td>
* “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method,
* include multiple instances of the &lt;payment_accepted&gt; attribute for each acceptable
* method.</font></td>
*
* </tr>
*
@ -1495,14 +1544,17 @@ public interface Product extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_accepted"></a>payment_accepted</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_accepted"></a>payment_accepted</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,”
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are
* “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,”
*
* “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method, include multiple instances of the &lt;payment_accepted&gt;
* attribute for each acceptable method.</font></td>
* “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method,
* include multiple instances of the &lt;payment_accepted&gt; attribute for each acceptable
* method.</font></td>
*
* </tr>
*
@ -1540,7 +1592,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
*
* </tr>
* <tr valign="top">
@ -1552,7 +1605,8 @@ public interface Product extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
* </tr>
* <tr valign="top">
*
@ -1581,7 +1635,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
*
* </tr>
* <tr valign="top">
@ -1593,7 +1648,8 @@ public interface Product extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
* </tr>
* <tr valign="top">
*
@ -1623,13 +1679,15 @@ public interface Product extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="pickup"></a>pickup</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="pickup"></a>pickup</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Information about whether or not an item is available for pick up. Acceptable values are "True and "False". </font></td>
* <td><font size="-1"> Information about whether or not an item is available for pick up.
* Acceptable values are "True and "False". </font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
@ -1667,13 +1725,15 @@ public interface Product extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="pickup"></a>pickup</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="pickup"></a>pickup</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Information about whether or not an item is available for pick up. Acceptable values are "True and "False". </font></td>
* <td><font size="-1"> Information about whether or not an item is available for pick up.
* Acceptable values are "True and "False". </font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
@ -1712,12 +1772,14 @@ public interface Product extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="price"></a>price</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="price"></a>price</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of
* &lt;shipping&gt;, the value included reflects the price of shipping.</font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable.
* Numerice values only. When used as a sub-attribute of &lt;shipping&gt;, the value included
* reflects the price of shipping.</font></td>
*
* </tr>
* <tr valign="top">
@ -1758,12 +1820,14 @@ public interface Product extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="price"></a>price</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="price"></a>price</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of
* &lt;shipping&gt;, the value included reflects the price of shipping.</font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable.
* Numerice values only. When used as a sub-attribute of &lt;shipping&gt;, the value included
* reflects the price of shipping.</font></td>
*
* </tr>
* <tr valign="top">
@ -1802,13 +1866,15 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="price_type"></a>price_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="price_type"></a>price_type</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are “negotiable,” or “starting.” The default is “starting”</font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are “negotiable,” or
* “starting.” The default is “starting”</font></td>
* </tr>
* <tr valign="top">
*
@ -1843,13 +1909,15 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="price_type"></a>price_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="price_type"></a>price_type</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are “negotiable,” or “starting.” The default is “starting”</font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are “negotiable,” or
* “starting.” The default is “starting”</font></td>
* </tr>
* <tr valign="top">
*
@ -1962,7 +2030,8 @@ public interface Product extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="product_type"></a>product_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="product_type"></a>product_type</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -1999,7 +2068,8 @@ public interface Product extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="product_type"></a>product_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="product_type"></a>product_type</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -2037,13 +2107,14 @@ public interface Product extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="quantity"></a>quantity</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="quantity"></a>quantity</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not
* applicable. </font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left
* blank if you have a large quantity or if it is not applicable. </font></td>
*
* </tr>
* <tr valign="top">
@ -2085,13 +2156,14 @@ public interface Product extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="quantity"></a>quantity</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="quantity"></a>quantity</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not
* applicable. </font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left
* blank if you have a large quantity or if it is not applicable. </font></td>
*
* </tr>
* <tr valign="top">
@ -2139,12 +2211,14 @@ public interface Product extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included
* in the shipping attribute:
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be
* included for each item. Three sub-attributes are included in the shipping attribute:
* <ul type="disc">
*
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166 country codes.</li>
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS',
* 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166
* country codes.</li>
* <li>price = the price of shipping.</li>
* </ul>
* </font></td>
@ -2195,12 +2269,14 @@ public interface Product extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included
* in the shipping attribute:
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be
* included for each item. Three sub-attributes are included in the shipping attribute:
* <ul type="disc">
*
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166 country codes.</li>
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS',
* 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166
* country codes.</li>
* <li>price = the price of shipping.</li>
* </ul>
* </font></td>
@ -2245,13 +2321,15 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="size"></a>size</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="size"></a>size</b></font></td>
* </tr>
*
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Dimensions of the item, expressed in either two or three dimensions.</font></td>
* <td><font size="-1"> Dimensions of the item, expressed in either two or three
* dimensions.</font></td>
* </tr>
* <tr valign="top">
*
@ -2285,13 +2363,15 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="size"></a>size</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="size"></a>size</b></font></td>
* </tr>
*
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Dimensions of the item, expressed in either two or three dimensions.</font></td>
* <td><font size="-1"> Dimensions of the item, expressed in either two or three
* dimensions.</font></td>
* </tr>
* <tr valign="top">
*
@ -2324,7 +2404,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="tax_percent"></a>tax_percent</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="tax_percent"></a>tax_percent</b></font></td>
* </tr>
*
* <tr valign="top">
@ -2366,7 +2447,8 @@ public interface Product extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="tax_percent"></a>tax_percent</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="tax_percent"></a>tax_percent</b></font></td>
* </tr>
*
* <tr valign="top">
@ -2583,7 +2665,8 @@ public interface Product extends GlobalInterface {
* <tr valign="top">
*
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="weight"></a>weight</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="weight"></a>weight</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -2624,7 +2707,8 @@ public interface Product extends GlobalInterface {
* <tr valign="top">
*
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="weight"></a>weight</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="weight"></a>weight</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>

112
src/main/java/org/rometools/feed/module/base/Review.java
View file

@ -45,7 +45,8 @@ import java.util.Date;
import org.rometools.feed.module.base.types.FloatUnit;
/**
* This is an interface for the GoogleBase plug in that exposes methods used for critical reviews of other things.
* This is an interface for the GoogleBase plug in that exposes methods used for critical reviews of
* other things.
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>
* @version $Revision: 1.1 $
@ -59,7 +60,8 @@ public interface Review extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="author"></a>author</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="author"></a>author</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -96,7 +98,8 @@ public interface Review extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="author"></a>author</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="author"></a>author</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -131,7 +134,8 @@ public interface Review extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -141,7 +145,8 @@ public interface Review extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -169,7 +174,8 @@ public interface Review extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -179,7 +185,8 @@ public interface Review extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -206,7 +213,8 @@ public interface Review extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -243,7 +251,8 @@ public interface Review extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -282,7 +291,8 @@ public interface Review extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="name_of_item_being_reviewed"></a>name_of_item_being_reviewed</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="name_of_item_being_reviewed"></a>name_of_item_being_reviewed</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -293,7 +303,8 @@ public interface Review extends GlobalInterface {
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
* <td><font size="-1"> &lt;g:name_of_item_being__reviewed&gt;Fleur de lys Restaurant&lt;/g:name_of_item_being_reviewed&gt;</font></td>
* <td><font size="-1"> &lt;g:name_of_item_being__reviewed&gt;Fleur de lys
* Restaurant&lt;/g:name_of_item_being_reviewed&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -319,7 +330,8 @@ public interface Review extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="name_of_item_being_reviewed"></a>name_of_item_being_reviewed</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="name_of_item_being_reviewed"></a>name_of_item_being_reviewed</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -330,7 +342,8 @@ public interface Review extends GlobalInterface {
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
* <td><font size="-1"> &lt;g:name_of_item_being__reviewed&gt;Fleur de lys Restaurant&lt;/g:name_of_item_being_reviewed&gt;</font></td>
* <td><font size="-1"> &lt;g:name_of_item_being__reviewed&gt;Fleur de lys
* Restaurant&lt;/g:name_of_item_being_reviewed&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -355,14 +368,16 @@ public interface Review extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="publish_date"></a>publish_date</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="publish_date"></a>publish_date</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Date the item was published in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a> format:
* YYYY-MM-DD</font></td>
* <td><font size="-1"> Date the item was published in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DD</font></td>
*
* </tr>
* <tr valign="top">
@ -397,14 +412,16 @@ public interface Review extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="publish_date"></a>publish_date</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="publish_date"></a>publish_date</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Date the item was published in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a> format:
* YYYY-MM-DD</font></td>
* <td><font size="-1"> Date the item was published in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DD</font></td>
*
* </tr>
* <tr valign="top">
@ -438,12 +455,14 @@ public interface Review extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="rating"></a>rating</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="rating"></a>rating</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Rating of the product or service on a scale of 1-5, with 5 as the best. Numeric values only.</font></td>
* <td><font size="-1"> Rating of the product or service on a scale of 1-5, with 5 as the best.
* Numeric values only.</font></td>
* </tr>
*
* <tr valign="top">
@ -480,12 +499,14 @@ public interface Review extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="rating"></a>rating</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="rating"></a>rating</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Rating of the product or service on a scale of 1-5, with 5 as the best. Numeric values only.</font></td>
* <td><font size="-1"> Rating of the product or service on a scale of 1-5, with 5 as the best.
* Numeric values only.</font></td>
* </tr>
*
* <tr valign="top">
@ -523,7 +544,8 @@ public interface Review extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="review_type"></a>review_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="review_type"></a>review_type</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
@ -565,7 +587,8 @@ public interface Review extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="review_type"></a>review_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="review_type"></a>review_type</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
@ -602,18 +625,20 @@ public interface Review extends GlobalInterface {
public String getReviewType();
/**
* The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site).
* The type of rating being provided: editorial (a review written by a member of your staff) or
* “user” ( a review written by a user of your site).
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="reviewer_type"></a>reviewer_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="reviewer_type"></a>reviewer_type</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of
* your site)</font></td>
* <td><font size="-1"> The type of rating being provided: editorial (a review written by a
* member of your staff) or “user” ( a review written by a user of your site)</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
@ -636,24 +661,26 @@ public interface Review extends GlobalInterface {
* </tbody>
* </table>
*
* @param reviewerType The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of
* your site).
* @param reviewerType The type of rating being provided: editorial (a review written by a
* member of your staff) or “user” ( a review written by a user of your site).
*/
public void setReviewerType(String reviewerType);
/**
* The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site).
* The type of rating being provided: editorial (a review written by a member of your staff) or
* “user” ( a review written by a user of your site).
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="reviewer_type"></a>reviewer_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="reviewer_type"></a>reviewer_type</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of
* your site)</font></td>
* <td><font size="-1"> The type of rating being provided: editorial (a review written by a
* member of your staff) or “user” ( a review written by a user of your site)</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
@ -676,7 +703,8 @@ public interface Review extends GlobalInterface {
* </tbody>
* </table>
*
* @return The type of rating being provided: editorial (a review written by a member of your staff) or “user” ( a review written by a user of your site).
* @return The type of rating being provided: editorial (a review written by a member of your
* staff) or “user” ( a review written by a user of your site).
*/
public String getReviewerType();
@ -687,7 +715,8 @@ public interface Review extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="url_of_item_being_reviewed"></a>url_of_item_being_reviewed</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="url_of_item_being_reviewed"></a>url_of_item_being_reviewed</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
@ -699,7 +728,8 @@ public interface Review extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:url_of_item_being_reviewed&gt;http://www.fleurdelyssf.com/&lt;/g:url_of_item_being_reviewed&gt;</font></td>
* <td><font size="-1"> &lt;g:url_of_item_being_reviewed&gt;http://www.fleurdelyssf.com/&lt;/g:
* url_of_item_being_reviewed&gt;</font></td>
* </tr>
*
* <tr valign="top">
@ -729,7 +759,8 @@ public interface Review extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="url_of_item_being_reviewed"></a>url_of_item_being_reviewed</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="url_of_item_being_reviewed"></a>url_of_item_being_reviewed</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
@ -741,7 +772,8 @@ public interface Review extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:url_of_item_being_reviewed&gt;http://www.fleurdelyssf.com/&lt;/g:url_of_item_being_reviewed&gt;</font></td>
* <td><font size="-1"> &lt;g:url_of_item_being_reviewed&gt;http://www.fleurdelyssf.com/&lt;/g:
* url_of_item_being_reviewed&gt;</font></td>
* </tr>
*
* <tr valign="top">

49
src/main/java/org/rometools/feed/module/base/ScholarlyArticle.java
View file

@ -42,7 +42,8 @@ package org.rometools.feed.module.base;
import java.util.Date;
/**
* This is an interface for the GoogleBase plug in that exposes methods used for Scholarly publication, research studies and reference materials.
* This is an interface for the GoogleBase plug in that exposes methods used for Scholarly
* publication, research studies and reference materials.
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>
* @version $Revision: 1.2 $
@ -54,7 +55,8 @@ public interface ScholarlyArticle extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="author"></a>author</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="author"></a>author</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -89,7 +91,8 @@ public interface ScholarlyArticle extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="author"></a>author</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="author"></a>author</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -125,7 +128,8 @@ public interface ScholarlyArticle extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="pages"></a>pages</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="pages"></a>pages</b></font></td>
*
* </tr>
* <tr valign="top">
@ -166,7 +170,8 @@ public interface ScholarlyArticle extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="pages"></a>pages</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="pages"></a>pages</b></font></td>
*
* </tr>
* <tr valign="top">
@ -207,7 +212,8 @@ public interface ScholarlyArticle extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="publication_name"></a>publication_name</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="publication_name"></a>publication_name</b></font></td>
* </tr>
*
* <tr valign="top">
@ -219,7 +225,8 @@ public interface ScholarlyArticle extends GlobalInterface {
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Example</b></font></td>
* <td><font size="-1"> &lt;g:publication_name&gt; Journal of Appropriate Technology&lt;/g:publication_name&gt;</font></td>
* <td><font size="-1"> &lt;g:publication_name&gt; Journal of Appropriate
* Technology&lt;/g:publication_name&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -248,7 +255,8 @@ public interface ScholarlyArticle extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="publication_name"></a>publication_name</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="publication_name"></a>publication_name</b></font></td>
* </tr>
*
* <tr valign="top">
@ -260,7 +268,8 @@ public interface ScholarlyArticle extends GlobalInterface {
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Example</b></font></td>
* <td><font size="-1"> &lt;g:publication_name&gt; Journal of Appropriate Technology&lt;/g:publication_name&gt;</font></td>
* <td><font size="-1"> &lt;g:publication_name&gt; Journal of Appropriate
* Technology&lt;/g:publication_name&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -288,7 +297,8 @@ public interface ScholarlyArticle extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="publication_volume"></a>publication_volume</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="publication_volume"></a>publication_volume</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -326,7 +336,8 @@ public interface ScholarlyArticle extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="publication_volume"></a>publication_volume</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="publication_volume"></a>publication_volume</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
@ -364,15 +375,17 @@ public interface ScholarlyArticle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="publish_date"></a>publish_date</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="publish_date"></a>publish_date</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
*
* <b>Details</b></font></td>
* <td><font size="-1"> Date the item was published in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a> format:
* YYYY-MM-DD</font></td>
* <td><font size="-1"> Date the item was published in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DD</font></td>
*
* </tr>
* <tr valign="top">
@ -408,15 +421,17 @@ public interface ScholarlyArticle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="publish_date"></a>publish_date</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="publish_date"></a>publish_date</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
*
* <b>Details</b></font></td>
* <td><font size="-1"> Date the item was published in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a> format:
* YYYY-MM-DD</font></td>
* <td><font size="-1"> Date the item was published in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DD</font></td>
*
* </tr>
* <tr valign="top">

182
src/main/java/org/rometools/feed/module/base/Service.java
View file

@ -58,14 +58,16 @@ public interface Service extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -100,14 +102,16 @@ public interface Service extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -142,7 +146,8 @@ public interface Service extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -152,7 +157,8 @@ public interface Service extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -180,7 +186,8 @@ public interface Service extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -190,7 +197,8 @@ public interface Service extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -217,7 +225,8 @@ public interface Service extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -254,7 +263,8 @@ public interface Service extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -292,32 +302,37 @@ public interface Service extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -338,32 +353,37 @@ public interface Service extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -385,14 +405,17 @@ public interface Service extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_accepted"></a>payment_accepted</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_accepted"></a>payment_accepted</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are
* "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
*
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the
* &lt;payment_accepted&gt; attribute for each acceptable method.</font></td>
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one
* method, include multiple instances of the &lt;payment_accepted&gt; attribute for each
* acceptable method.</font></td>
*
* </tr>
*
@ -433,14 +456,17 @@ public interface Service extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_accepted"></a>payment_accepted</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_accepted"></a>payment_accepted</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are
* "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
*
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the
* &lt;payment_accepted&gt; attribute for each acceptable method.</font></td>
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one
* method, include multiple instances of the &lt;payment_accepted&gt; attribute for each
* acceptable method.</font></td>
*
* </tr>
*
@ -480,7 +506,8 @@ public interface Service extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
* </tr>
* <tr valign="top">
*
@ -491,7 +518,8 @@ public interface Service extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -519,7 +547,8 @@ public interface Service extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
* </tr>
* <tr valign="top">
*
@ -530,7 +559,8 @@ public interface Service extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -560,12 +590,14 @@ public interface Service extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="price"></a>price</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="price"></a>price</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of
* &lt;shipping&gt;, the value included reflects the price of shipping.</font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable.
* Numerice values only. When used as a sub-attribute of &lt;shipping&gt;, the value included
* reflects the price of shipping.</font></td>
*
* </tr>
* <tr valign="top">
@ -606,12 +638,14 @@ public interface Service extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="price"></a>price</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="price"></a>price</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of
* &lt;shipping&gt;, the value included reflects the price of shipping.</font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable.
* Numerice values only. When used as a sub-attribute of &lt;shipping&gt;, the value included
* reflects the price of shipping.</font></td>
*
* </tr>
* <tr valign="top">
@ -651,13 +685,15 @@ public interface Service extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="price_type"></a>price_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="price_type"></a>price_type</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are <EFBFBD>negotiable,<EFBFBD> or <EFBFBD>starting.<EFBFBD> The default is <EFBFBD>starting<EFBFBD></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are <EFBFBD>negotiable,<EFBFBD> or
* <EFBFBD>starting.<EFBFBD> The default is <EFBFBD>starting<EFBFBD></font></td>
* </tr>
* <tr valign="top">
*
@ -693,13 +729,15 @@ public interface Service extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="price_type"></a>price_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="price_type"></a>price_type</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are <EFBFBD>negotiable,<EFBFBD> or <EFBFBD>starting.<EFBFBD> The default is <EFBFBD>starting<EFBFBD></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are <EFBFBD>negotiable,<EFBFBD> or
* <EFBFBD>starting.<EFBFBD> The default is <EFBFBD>starting<EFBFBD></font></td>
* </tr>
* <tr valign="top">
*
@ -735,13 +773,14 @@ public interface Service extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="quantity"></a>quantity</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="quantity"></a>quantity</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not
* applicable. </font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left
* blank if you have a large quantity or if it is not applicable. </font></td>
*
* </tr>
* <tr valign="top">
@ -783,13 +822,14 @@ public interface Service extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="quantity"></a>quantity</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="quantity"></a>quantity</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not
* applicable. </font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left
* blank if you have a large quantity or if it is not applicable. </font></td>
*
* </tr>
* <tr valign="top">
@ -832,12 +872,14 @@ public interface Service extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="service_type"></a>service_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="service_type"></a>service_type</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> The type of service being offered. Web hosting, legal, gardening, etc.</font></td>
* <td><font size="-1"> The type of service being offered. Web hosting, legal, gardening,
* etc.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
@ -869,12 +911,14 @@ public interface Service extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="service_type"></a>service_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="service_type"></a>service_type</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> The type of service being offered. Web hosting, legal, gardening, etc.</font></td>
* <td><font size="-1"> The type of service being offered. Web hosting, legal, gardening,
* etc.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
@ -911,12 +955,14 @@ public interface Service extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included
* in the shipping attribute:
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be
* included for each item. Three sub-attributes are included in the shipping attribute:
* <ul type="disc">
*
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166 country codes.</li>
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS',
* 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166
* country codes.</li>
* <li>price = the price of shipping.</li>
* </ul>
* </font></td>
@ -967,12 +1013,14 @@ public interface Service extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included
* in the shipping attribute:
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be
* included for each item. Three sub-attributes are included in the shipping attribute:
* <ul type="disc">
*
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166 country codes.</li>
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS',
* 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166
* country codes.</li>
* <li>price = the price of shipping.</li>
* </ul>
* </font></td>
@ -1016,7 +1064,8 @@ public interface Service extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="tax_percent"></a>tax_percent</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="tax_percent"></a>tax_percent</b></font></td>
* </tr>
*
* <tr valign="top">
@ -1058,7 +1107,8 @@ public interface Service extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="tax_percent"></a>tax_percent</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="tax_percent"></a>tax_percent</b></font></td>
* </tr>
*
* <tr valign="top">

218
src/main/java/org/rometools/feed/module/base/Travel.java
View file

@ -59,14 +59,16 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -101,14 +103,16 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -143,7 +147,8 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -153,7 +158,8 @@ public interface Travel extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -181,7 +187,8 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -191,7 +198,8 @@ public interface Travel extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -218,7 +226,8 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -255,7 +264,8 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -293,7 +303,8 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="from_location"></a>from_location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="from_location"></a>from_location</b></font></td>
*
* </tr>
* <tr valign="top">
@ -305,12 +316,15 @@ public interface Travel extends GlobalInterface {
* <td width="120"><font size="-1"><b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:from_location&gt;<st1:city>San Francisco</st1:city>, <st1:state>CA</st1:state>&lt;/g:from_location&gt;<br>
* &lt;g:from_location&gt;<st1:city>San Francisco</st1:city>,
* <st1:state>CA</st1:state>&lt;/g:from_location&gt;<br>
*
* &lt;g:from_location&gt;<st1:place><st1:city>Paris</st1:city>, <st1:country-region>France</st1:country-region></st1:place>&lt;/g:from_location&gt;<br>
* &lt;g:from_location&gt;<st1:place><st1:city>Paris</st1:city>,
* <st1:country-region>France</st1:country-region></st1:place>&lt;/g:from_location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:from_location&gt; <st1:place><st1:placename>San Francisco</st1:placename> <st1:placename>International</st1:placename>
* &lt;g:from_location&gt; <st1:place><st1:placename>San Francisco</st1:placename>
* <st1:placename>International</st1:placename>
* <st1:placetype>Airport</st1:placetype></st1:place>&lt;/g:from_location&gt;</font></td>
*
* </tr>
@ -338,7 +352,8 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="from_location"></a>from_location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="from_location"></a>from_location</b></font></td>
*
* </tr>
* <tr valign="top">
@ -350,12 +365,15 @@ public interface Travel extends GlobalInterface {
* <td width="120"><font size="-1"><b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:from_location&gt;<st1:city>San Francisco</st1:city>, <st1:state>CA</st1:state>&lt;/g:from_location&gt;<br>
* &lt;g:from_location&gt;<st1:city>San Francisco</st1:city>,
* <st1:state>CA</st1:state>&lt;/g:from_location&gt;<br>
*
* &lt;g:from_location&gt;<st1:place><st1:city>Paris</st1:city>, <st1:country-region>France</st1:country-region></st1:place>&lt;/g:from_location&gt;<br>
* &lt;g:from_location&gt;<st1:place><st1:city>Paris</st1:city>,
* <st1:country-region>France</st1:country-region></st1:place>&lt;/g:from_location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:from_location&gt; <st1:place><st1:placename>San Francisco</st1:placename> <st1:placename>International</st1:placename>
* &lt;g:from_location&gt; <st1:place><st1:placename>San Francisco</st1:placename>
* <st1:placename>International</st1:placename>
* <st1:placetype>Airport</st1:placetype></st1:place>&lt;/g:from_location&gt;</font></td>
*
* </tr>
@ -384,14 +402,17 @@ public interface Travel extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_accepted"></a>payment_accepted</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_accepted"></a>payment_accepted</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,”
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are
* “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,”
*
* “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method, include multiple instances of the &lt;payment_accepted&gt;
* attribute for each acceptable method.</font></td>
* “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method,
* include multiple instances of the &lt;payment_accepted&gt; attribute for each acceptable
* method.</font></td>
*
* </tr>
*
@ -430,14 +451,17 @@ public interface Travel extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_accepted"></a>payment_accepted</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_accepted"></a>payment_accepted</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,”
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are
* “Cash,” “Check,” “Traveler’s Check,” “Visa,” “MasterCard,”
*
* “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method, include multiple instances of the &lt;payment_accepted&gt;
* attribute for each acceptable method.</font></td>
* “American Express,” “Discover,” or “Wire transfer.” If you accept more than one method,
* include multiple instances of the &lt;payment_accepted&gt; attribute for each acceptable
* method.</font></td>
*
* </tr>
*
@ -475,7 +499,8 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
*
* </tr>
* <tr valign="top">
@ -487,7 +512,8 @@ public interface Travel extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
* </tr>
* <tr valign="top">
*
@ -516,7 +542,8 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
*
* </tr>
* <tr valign="top">
@ -528,7 +555,8 @@ public interface Travel extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
* </tr>
* <tr valign="top">
*
@ -559,12 +587,14 @@ public interface Travel extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="price"></a>price</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="price"></a>price</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of
* &lt;shipping&gt;, the value included reflects the price of shipping.</font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable.
* Numerice values only. When used as a sub-attribute of &lt;shipping&gt;, the value included
* reflects the price of shipping.</font></td>
*
* </tr>
* <tr valign="top">
@ -603,13 +633,15 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="price_type"></a>price_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="price_type"></a>price_type</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are “negotiable,” or “starting.” The default is “starting”</font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are “negotiable,” or
* “starting.” The default is “starting”</font></td>
* </tr>
* <tr valign="top">
*
@ -644,13 +676,15 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="price_type"></a>price_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="price_type"></a>price_type</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are “negotiable,” or “starting.” The default is “starting”</font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are “negotiable,” or
* “starting.” The default is “starting”</font></td>
* </tr>
* <tr valign="top">
*
@ -686,13 +720,14 @@ public interface Travel extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="quantity"></a>quantity</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="quantity"></a>quantity</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not
* applicable. </font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left
* blank if you have a large quantity or if it is not applicable. </font></td>
*
* </tr>
* <tr valign="top">
@ -734,13 +769,14 @@ public interface Travel extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="quantity"></a>quantity</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="quantity"></a>quantity</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not
* applicable. </font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left
* blank if you have a large quantity or if it is not applicable. </font></td>
*
* </tr>
* <tr valign="top">
@ -781,7 +817,8 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="tax_percent"></a>tax_percent</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="tax_percent"></a>tax_percent</b></font></td>
* </tr>
*
* <tr valign="top">
@ -823,7 +860,8 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="tax_percent"></a>tax_percent</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="tax_percent"></a>tax_percent</b></font></td>
* </tr>
*
* <tr valign="top">
@ -952,7 +990,8 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="to_location"></a>to_location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="to_location"></a>to_location</b></font></td>
* </tr>
*
* <tr valign="top">
@ -967,11 +1006,14 @@ public interface Travel extends GlobalInterface {
* <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:to_location&gt;<st1:city>San Francisco</st1:city>, <st1:state>CA</st1:state>&lt;/g:to_location&gt;<br>
* &lt;g:to_location&gt;<st1:place><st1:city>Paris</st1:city>, <st1:country-region>France</st1:country-region></st1:place>&lt;/g:to_location&gt;<br>
* &lt;g:to_location&gt;<st1:city>San Francisco</st1:city>,
* <st1:state>CA</st1:state>&lt;/g:to_location&gt;<br>
* &lt;g:to_location&gt;<st1:place><st1:city>Paris</st1:city>,
* <st1:country-region>France</st1:country-region></st1:place>&lt;/g:to_location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:to_location&gt;<st1:place><st1:placename>San Francisco</st1:placename> <st1:placename>International</st1:placename>
* &lt;g:to_location&gt;<st1:place><st1:placename>San Francisco</st1:placename>
* <st1:placename>International</st1:placename>
* <st1:placetype>Airport</st1:placetype></st1:place>&lt;/g:to_location&gt;</font></td>
* </tr>
* <tr valign="top">
@ -999,7 +1041,8 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="to_location"></a>to_location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="to_location"></a>to_location</b></font></td>
* </tr>
*
* <tr valign="top">
@ -1014,11 +1057,14 @@ public interface Travel extends GlobalInterface {
* <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:to_location&gt;<st1:city>San Francisco</st1:city>, <st1:state>CA</st1:state>&lt;/g:to_location&gt;<br>
* &lt;g:to_location&gt;<st1:place><st1:city>Paris</st1:city>, <st1:country-region>France</st1:country-region></st1:place>&lt;/g:to_location&gt;<br>
* &lt;g:to_location&gt;<st1:city>San Francisco</st1:city>,
* <st1:state>CA</st1:state>&lt;/g:to_location&gt;<br>
* &lt;g:to_location&gt;<st1:place><st1:city>Paris</st1:city>,
* <st1:country-region>France</st1:country-region></st1:place>&lt;/g:to_location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:to_location&gt;<st1:place><st1:placename>San Francisco</st1:placename> <st1:placename>International</st1:placename>
* &lt;g:to_location&gt;<st1:place><st1:placename>San Francisco</st1:placename>
* <st1:placename>International</st1:placename>
* <st1:placetype>Airport</st1:placetype></st1:place>&lt;/g:to_location&gt;</font></td>
* </tr>
* <tr valign="top">
@ -1045,13 +1091,16 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="travel_date_range"></a>travel_date_range</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="travel_date_range"></a>travel_date_range</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Departure date and time of the trip in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DD,hh:mmAM (12 hour clock) or YYYY-MM-DD,hh:mm (24 hour clock). Two sub-attributes are included in travel_date_range attribute.
* <td><font size="-1"> Departure date and time of the trip in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DD,hh:mmAM (12 hour clock) or YYYY-MM-DD,hh:mm (24 hour clock). Two
* sub-attributes are included in travel_date_range attribute.
* <ul type="disc">
*
* <li>start = Start date and time of a trip in format YYYY-MM-DDThh:mm:ss</li>
@ -1094,13 +1143,16 @@ public interface Travel extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a name="travel_date_range"></a>travel_date_range</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"> <b><a
* name="travel_date_range"></a>travel_date_range</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Departure date and time of the trip in <a href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DD,hh:mmAM (12 hour clock) or YYYY-MM-DD,hh:mm (24 hour clock). Two sub-attributes are included in travel_date_range attribute.
* <td><font size="-1"> Departure date and time of the trip in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/datesandtime.html">ISO 8601</a>
* format: YYYY-MM-DD,hh:mmAM (12 hour clock) or YYYY-MM-DD,hh:mm (24 hour clock). Two
* sub-attributes are included in travel_date_range attribute.
* <ul type="disc">
*
* <li>start = Start date and time of a trip in format YYYY-MM-DDThh:mm:ss</li>
@ -1143,32 +1195,37 @@ public interface Travel extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -1189,32 +1246,37 @@ public interface Travel extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -1242,12 +1304,14 @@ public interface Travel extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included
* in the shipping attribute:
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be
* included for each item. Three sub-attributes are included in the shipping attribute:
* <ul type="disc">
*
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166 country codes.</li>
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS',
* 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166
* country codes.</li>
* <li>price = the price of shipping.</li>
* </ul>
* </font></td>

3
src/main/java/org/rometools/feed/module/base/Unknown.java
View file

@ -44,7 +44,8 @@ import java.net.URL;
import org.rometools.feed.module.base.types.IntUnit;
/**
* This interface contains all the other schema elements that the document doesn't associate with a particular type.
* This interface contains all the other schema elements that the document doesn't associate with a
* particular type.
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>
*/

3
src/main/java/org/rometools/feed/module/base/ValidationException.java
View file

@ -21,7 +21,8 @@
package org.rometools.feed.module.base;
/**
* This is an unchecked exception that is thrown when a data value violates the Google Schema limits.
* This is an unchecked exception that is thrown when a data value violates the Google Schema
* limits.
*
* @version $Revision: 1.1 $
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>

218
src/main/java/org/rometools/feed/module/base/Vehicle.java
View file

@ -60,7 +60,8 @@ public interface Vehicle extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="color"></a>color</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="color"></a>color</b></font></td>
*
* </tr>
* <tr valign="top">
@ -100,7 +101,8 @@ public interface Vehicle extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="color"></a>color</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="color"></a>color</b></font></td>
*
* </tr>
* <tr valign="top">
@ -139,7 +141,8 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="condition"></a>condition</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="condition"></a>condition</b></font></td>
*
* </tr>
* <tr valign="top">
@ -177,7 +180,8 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="condition"></a>condition</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="condition"></a>condition</b></font></td>
*
* </tr>
* <tr valign="top">
@ -215,14 +219,16 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -257,14 +263,16 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="currency"></a>currency</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="currency"></a>currency</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
*
* <td><font size="-1">Currency of the price amount for an item. Values must be in <a
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a> currency code format.</font></td>
* href="http://www.iso.org/iso/en/prods-services/popstds/currencycodeslist.html">ISO 4217</a>
* currency code format.</font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
@ -299,7 +307,8 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -309,7 +318,8 @@ public interface Vehicle extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -337,7 +347,8 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -347,7 +358,8 @@ public interface Vehicle extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -374,7 +386,8 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -411,7 +424,8 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -444,37 +458,43 @@ public interface Vehicle extends GlobalInterface {
public FloatUnit getDeliveryRadius();
/**
* Location of a property. Should include street, city, state, postal code, and country, in that order.
* Location of a property. Should include street, city, state, postal code, and country, in that
* order.
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -485,42 +505,49 @@ public interface Vehicle extends GlobalInterface {
* </tbody>
* </table>
*
* @param location Location of a property. Should include street, city, state, postal code, and country, in that order.
* @param location Location of a property. Should include street, city, state, postal code, and
* country, in that order.
*/
public void setLocation(String location);
/**
* Location of a property. Should include street, city, state, postal code, and country, in that order.
* Location of a property. Should include street, city, state, postal code, and country, in that
* order.
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -531,7 +558,8 @@ public interface Vehicle extends GlobalInterface {
* </tbody>
* </table>
*
* @return Location of a property. Should include street, city, state, postal code, and country, in that order.
* @return Location of a property. Should include street, city, state, postal code, and country,
* in that order.
*/
public String getLocation();
@ -542,7 +570,8 @@ public interface Vehicle extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="make"></a>make</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="make"></a>make</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
@ -584,7 +613,8 @@ public interface Vehicle extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="make"></a>make</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="make"></a>make</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1">
@ -626,7 +656,8 @@ public interface Vehicle extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd"><font size="-1"><b><a name="mileage"></a>mileage</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"><b><a name="mileage"></a>mileage</b></font>
* </td>
*
* </tr>
* <tr valign="top">
@ -668,7 +699,8 @@ public interface Vehicle extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd"><font size="-1"><b><a name="mileage"></a>mileage</b></font></td>
* <td colspan="2" bgcolor="#dddddd"><font size="-1"><b><a name="mileage"></a>mileage</b></font>
* </td>
*
* </tr>
* <tr valign="top">
@ -782,14 +814,17 @@ public interface Vehicle extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_accepted"></a>payment_accepted</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_accepted"></a>payment_accepted</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are
* "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
*
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the
* &lt;payment_accepted&gt; attribute for each acceptable method.</font></td>
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one
* method, include multiple instances of the &lt;payment_accepted&gt; attribute for each
* acceptable method.</font></td>
*
* </tr>
*
@ -830,14 +865,17 @@ public interface Vehicle extends GlobalInterface {
*
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_accepted"></a>payment_accepted</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_accepted"></a>payment_accepted</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
* <td><font size="-1"> Acceptable payment methods for item purchases. Acceptable values are
* "Cash," "Check," "Traveler’s Check," "Visa," "MasterCard,"
*
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one method, include multiple instances of the
* &lt;payment_accepted&gt; attribute for each acceptable method.</font></td>
* "American Express," "Discover," "Wire transfer" or "Paypal." If you accept more than one
* method, include multiple instances of the &lt;payment_accepted&gt; attribute for each
* acceptable method.</font></td>
*
* </tr>
*
@ -877,7 +915,8 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
* </tr>
* <tr valign="top">
*
@ -888,7 +927,8 @@ public interface Vehicle extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -916,7 +956,8 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="payment_notes"></a>payment_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="payment_notes"></a>payment_notes</b></font></td>
* </tr>
* <tr valign="top">
*
@ -927,7 +968,8 @@ public interface Vehicle extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local orders.&lt;/g:payment_notes&gt;</font></td>
* <td><font size="-1"> &lt;g:payment_notes&gt;Cash only for local
* orders.&lt;/g:payment_notes&gt;</font></td>
*
* </tr>
* <tr valign="top">
@ -957,12 +999,14 @@ public interface Vehicle extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="price"></a>price</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="price"></a>price</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of
* &lt;shipping&gt;, the value included reflects the price of shipping.</font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable.
* Numerice values only. When used as a sub-attribute of &lt;shipping&gt;, the value included
* reflects the price of shipping.</font></td>
*
* </tr>
* <tr valign="top">
@ -1003,12 +1047,14 @@ public interface Vehicle extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="price"></a>price</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="price"></a>price</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable. Numerice values only. When used as a sub-attribute of
* &lt;shipping&gt;, the value included reflects the price of shipping.</font></td>
* <td><font size="-1"> Prices can be a single price, 0 (free), or blank if not applicable.
* Numerice values only. When used as a sub-attribute of &lt;shipping&gt;, the value included
* reflects the price of shipping.</font></td>
*
* </tr>
* <tr valign="top">
@ -1048,13 +1094,15 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="price_type"></a>price_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="price_type"></a>price_type</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are <EFBFBD>negotiable,<EFBFBD> or <EFBFBD>starting.<EFBFBD> The default is <EFBFBD>starting<EFBFBD></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are <EFBFBD>negotiable,<EFBFBD> or
* <EFBFBD>starting.<EFBFBD> The default is <EFBFBD>starting<EFBFBD></font></td>
* </tr>
* <tr valign="top">
*
@ -1090,13 +1138,15 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="price_type"></a>price_type</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="price_type"></a>price_type</b></font></td>
* </tr>
*
* <tr valign="top">
*
* <td width="120"><font size="-1"><b>Details</b></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are <EFBFBD>negotiable,<EFBFBD> or <EFBFBD>starting.<EFBFBD> The default is <EFBFBD>starting<EFBFBD></font></td>
* <td><font size="-1">The type of pricing for the item. Acceptable values are <EFBFBD>negotiable,<EFBFBD> or
* <EFBFBD>starting.<EFBFBD> The default is <EFBFBD>starting<EFBFBD></font></td>
* </tr>
* <tr valign="top">
*
@ -1132,13 +1182,14 @@ public interface Vehicle extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="quantity"></a>quantity</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="quantity"></a>quantity</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not
* applicable. </font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left
* blank if you have a large quantity or if it is not applicable. </font></td>
*
* </tr>
* <tr valign="top">
@ -1180,13 +1231,14 @@ public interface Vehicle extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="quantity"></a>quantity</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="quantity"></a>quantity</b></font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left blank if you have a large quantity or if it is not
* applicable. </font></td>
* <td><font size="-1"> The number of units available for purchase. This attribute can be left
* blank if you have a large quantity or if it is not applicable. </font></td>
*
* </tr>
* <tr valign="top">
@ -1234,12 +1286,14 @@ public interface Vehicle extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included
* in the shipping attribute:
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be
* included for each item. Three sub-attributes are included in the shipping attribute:
* <ul type="disc">
*
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166 country codes.</li>
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS',
* 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166
* country codes.</li>
* <li>price = the price of shipping.</li>
* </ul>
* </font></td>
@ -1290,12 +1344,14 @@ public interface Vehicle extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Details</b></font></td>
*
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be included for each item. Three sub-attributes are included
* in the shipping attribute:
* <td><font size="-1"> Shipping options available for an item. Up to 10 shipping options can be
* included for each item. Three sub-attributes are included in the shipping attribute:
* <ul type="disc">
*
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166 country codes.</li>
* <li>service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS',
* 'DHL', 'Mail', and 'Other'</li>
* <li>country = The country an item will ship to. Only acceptable values are<b> </b>ISO 3166
* country codes.</li>
* <li>price = the price of shipping.</li>
* </ul>
* </font></td>
@ -1339,7 +1395,8 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="tax_percent"></a>tax_percent</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="tax_percent"></a>tax_percent</b></font></td>
* </tr>
*
* <tr valign="top">
@ -1381,7 +1438,8 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="tax_percent"></a>tax_percent</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="tax_percent"></a>tax_percent</b></font></td>
* </tr>
*
* <tr valign="top">
@ -1596,7 +1654,8 @@ public interface Vehicle extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="vin"></a>vin</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="vin"></a>vin</b></font></td>
*
* </tr>
* <tr valign="top">
@ -1635,7 +1694,8 @@ public interface Vehicle extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="vin"></a>vin</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="vin"></a>vin</b></font></td>
*
* </tr>
* <tr valign="top">
@ -1675,7 +1735,8 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="year"></a>year</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="year"></a>year</b></font></td>
* </tr>
* <tr valign="top">
*
@ -1723,7 +1784,8 @@ public interface Vehicle extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="year"></a>year</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="year"></a>year</b></font></td>
* </tr>
* <tr valign="top">
*

56
src/main/java/org/rometools/feed/module/base/Wanted.java
View file

@ -54,7 +54,8 @@ public interface Wanted extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -64,7 +65,8 @@ public interface Wanted extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -92,7 +94,8 @@ public interface Wanted extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_notes"></a>delivery_notes</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_notes"></a>delivery_notes</b></font></td>
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"><b>Details</b></font></td>
@ -102,7 +105,8 @@ public interface Wanted extends GlobalInterface {
* <tr valign="top">
* <td width="120"><font size="-1"><b>Example</b></font></td>
* <td>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24 hours.&lt;g:/delivery_notes&gt;<br>
* <font size="-1">&lt;g:delivery_notes&gt;Items usually shipped within 24
* hours.&lt;g:/delivery_notes&gt;<br>
*
* </font></td>
*
@ -129,7 +133,8 @@ public interface Wanted extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -166,7 +171,8 @@ public interface Wanted extends GlobalInterface {
* <table border="1" cellpadding="5" cellspacing="0" width="640">
* <tbody>
* <tr valign="top">
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a name="delivery_radius"></a>delivery_radius</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"><b><a
* name="delivery_radius"></a>delivery_radius</b></font></td>
*
* </tr>
* <tr valign="top">
@ -204,32 +210,37 @@ public interface Wanted extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">
@ -250,32 +261,37 @@ public interface Wanted extends GlobalInterface {
* <tbody>
* <tr valign="top">
*
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a name="location"></a>location</b></font></td>
* <td colspan="2" bgcolor="#dddddd" valign="top"><font size="-1"> <b><a
* name="location"></a>location</b></font></td>
* </tr>
* <tr valign="top">
*
* <td width="120"><font size="-1"> <b>Details</b></font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code, and country, in that order. </font></td>
* <td><font size="-1"> Location of a property. Should include street, city, state, postal code,
* and country, in that order. </font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Example</b></font></td>
*
* <td><font size="-1"> <em>Acceptable:</em><br>
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place>123 Main St, <st1:city>Anytown</st1:city>,
* <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
*
* <em>Not acceptable:</em><br>
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt;<st1:place><st1:city>123</st1:city> Main St,, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;<br>
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>, <st1:postalcode>12345</st1:postalcode>,
* &lt;g:location&gt; <st1:place><st1:city>Anytown</st1:city>, <st1:state>CA</st1:state>,
* <st1:postalcode>12345</st1:postalcode>,
* <st1:country-region>USA</st1:country-region></st1:place>&lt;/g:location&gt;</font></td>
*
* </tr>
* <tr valign="top">
* <td width="120"><font size="-1"> <b>Attribute of</b></font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted
* Ads.</font></td>
* <td><font size="-1"> Reference Items, Events, Housing, Jobs, News and Articles, People
* profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.</font></td>
* </tr>
*
* <tr valign="top">

4
src/main/java/org/rometools/feed/module/base/types/ShortDate.java
View file

@ -42,8 +42,8 @@ package org.rometools.feed.module.base.types;
import java.util.Date;
/**
* This is a simple wrapper for java.util.Date that indicates it should be formatted without time of day for Google Base. It should be transparent to module
* developers.
* This is a simple wrapper for java.util.Date that indicates it should be formatted without time of
* day for Google Base. It should be transparent to module developers.
*
* Move along. Nothing to see here.
*

2
src/main/java/org/rometools/feed/module/content/io/ContentModuleParser.java
View file

@ -121,7 +121,7 @@ public class ContentModuleParser implements com.sun.syndication.io.ModuleParser
contentStrings.add(value.getText());
}
ci.setContentValueDOM((List<Content>) value.clone().getContent());
ci.setContentValueDOM(value.clone().getContent());
}
if (format != null) {

18
src/main/java/org/rometools/feed/module/georss/GeoRSSUtils.java
View file

@ -29,7 +29,8 @@ import com.sun.syndication.feed.synd.SyndFeed;
public class GeoRSSUtils {
/**
* This convenience method checks whether there is any geoRss Element and will return it (georss simple or W3GGeo).
* This convenience method checks whether there is any geoRss Element and will return it (georss
* simple or W3GGeo).
*
* @param entry the element in the feed which might have a georss element
* @return a georssmodule or null if none is present
@ -50,14 +51,17 @@ public class GeoRSSUtils {
return null;
/*
* if (geoRSSModule == null && w3cGeo != null) { geoRSSModule = w3cGeo; } else if (geoRSSModule == null && gml != null) { geoRSSModule = gml; } else if
* (geoRSSModule != null && w3cGeo != null) { // sanity check if (!geoRSSModule.getGeometry().equals(w3cGeo.getGeometry())) { throw new
* if (geoRSSModule == null && w3cGeo != null) { geoRSSModule = w3cGeo; } else if
* (geoRSSModule == null && gml != null) { geoRSSModule = gml; } else if (geoRSSModule !=
* null && w3cGeo != null) { // sanity check if
* (!geoRSSModule.getGeometry().equals(w3cGeo.getGeometry())) { throw new
* Error("geometry of simple and w3c do not match"); } } return geoRSSModule;
*/
}
/**
* This convenience method checks whether there is any geoRss Element and will return it (georss simple or W3GGeo).
* This convenience method checks whether there is any geoRss Element and will return it (georss
* simple or W3GGeo).
*
* @param feed the element in the feed which might have a georss element
* @return a georssmodule or null if none is present
@ -79,8 +83,10 @@ public class GeoRSSUtils {
return null;
/*
* if (geoRSSModule == null && w3cGeo != null) { geoRSSModule = w3cGeo; } else if (geoRSSModule == null && gml != null) { geoRSSModule = gml; } else if
* (geoRSSModule != null && w3cGeo != null) { // sanity check if (!geoRSSModule.getGeometry().equals(w3cGeo.getGeometry())) { throw new
* if (geoRSSModule == null && w3cGeo != null) { geoRSSModule = w3cGeo; } else if
* (geoRSSModule == null && gml != null) { geoRSSModule = gml; } else if (geoRSSModule !=
* null && w3cGeo != null) { // sanity check if
* (!geoRSSModule.getGeometry().equals(w3cGeo.getGeometry())) { throw new
* Error("geometry of simple and w3c do not match"); } } return geoRSSModule;
*/
}

5
src/main/java/org/rometools/feed/module/georss/geometries/Envelope.java
View file

@ -10,8 +10,9 @@
package org.rometools.feed.module.georss.geometries;
/**
* Envelope, a bounding box spanned by an upper right and lower left corner point. Note that if the box spans the -180 180 degree meridian the numerical value
* of the minLongitude may be greater than the maxLongitude.
* Envelope, a bounding box spanned by an upper right and lower left corner point. Note that if the
* box spans the -180 180 degree meridian the numerical value of the minLongitude may be greater
* than the maxLongitude.
*
* @author runaas
*/

3
src/main/java/org/rometools/feed/module/georss/geometries/LinearRing.java
View file

@ -10,7 +10,8 @@
package org.rometools.feed.module.georss.geometries;
/**
* Linear boundary object constructed by linear interpolation between points. Start and end point should be identical.
* Linear boundary object constructed by linear interpolation between points. Start and end point
* should be identical.
*
* @author runaas
*/

3
src/main/java/org/rometools/feed/module/georss/geometries/PositionList.java
View file

@ -122,7 +122,8 @@ public class PositionList implements Cloneable, Serializable {
}
/**
* Add a position at a given index in the list. The rest of the list is shifted one place to the "right"
* Add a position at a given index in the list. The rest of the list is shifted one place to the
* "right"
*
* @param pos position index
* @param latitude

3
src/main/java/org/rometools/feed/module/itunes/types/Category.java
View file

@ -43,7 +43,8 @@ package org.rometools.feed.module.itunes.types;
import java.io.Serializable;
/**
* This Category information. Basically a name and an optional Subcategory. Categories are defined by Apple. See ITMS for a view.
* This Category information. Basically a name and an optional Subcategory. Categories are defined
* by Apple. See ITMS for a view.
*
* @version $Revision: 1.2 $
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>

3
src/main/java/org/rometools/feed/module/itunes/types/Duration.java
View file

@ -46,7 +46,8 @@ import java.util.StringTokenizer;
import com.sun.syndication.io.impl.NumberParser;
/**
* An encapsulation of the duration of a podcast. This will serialize (via .toString()) to HH:MM:SS format, and can parse [H]*H:[M]*M:[S]*S or [M]*M:[S]*S.
* An encapsulation of the duration of a podcast. This will serialize (via .toString()) to HH:MM:SS
* format, and can parse [H]*H:[M]*M:[S]*S or [M]*M:[S]*S.
*
* @version $Revision: 1.7 $
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>

3
src/main/java/org/rometools/feed/module/mediarss/MediaEntryModuleImpl.java
View file

@ -40,7 +40,8 @@ public class MediaEntryModuleImpl extends MediaModuleImpl implements MediaEntryM
private static final long serialVersionUID = 1L;
/*
* the variables in the MediaModule are set when they apply to all MediaContent instances in the set
* the variables in the MediaModule are set when they apply to all MediaContent instances in the
* set
*/
private MediaContent[] mediaContents = new MediaContent[0];
private MediaGroup[] mediaGroups = new MediaGroup[0];

3
src/main/java/org/rometools/feed/module/mediarss/MediaModule.java
View file

@ -29,7 +29,8 @@ import com.sun.syndication.feed.module.Module;
/**
* This is the base module for MediaRSS.
* <p>
* It represents information that can be stored at the feed level, as well is a base for entry level information, as the same information can apply.
* It represents information that can be stored at the feed level, as well is a base for entry level
* information, as the same information can apply.
* </p>
*
* @author Nathanial X. Freitas

23
src/main/java/org/rometools/feed/module/mediarss/types/Category.java
View file

@ -31,7 +31,8 @@ import com.sun.syndication.feed.impl.ToStringBean;
*
* <strong>&lt;media:category&gt;</strong></p>
* <p>
* Allows a taxonomy to be set that gives an indication of the type of media content, and its particular contents. It has 2 optional attributes.
* Allows a taxonomy to be set that gives an indication of the type of media content, and its
* particular contents. It has 2 optional attributes.
* </p>
*
* <pre>
@ -47,12 +48,14 @@ import com.sun.syndication.feed.impl.ToStringBean;
* </pre>
*
* <p>
* <em>scheme</em> is the URI that identifies the categorization scheme. It is an optional attribute. If this attribute is not included, the default scheme is
* <em>scheme</em> is the URI that identifies the categorization scheme. It is an optional
* attribute. If this attribute is not included, the default scheme is
* 'http://search.yahoo.com/mrss/category_schema'.
* </p>
*
* <p>
* <em>label</em> is the human readable label that can be displayed in end user applications. It is an optional attribute.
* <em>label</em> is the human readable label that can be displayed in end user applications. It is
* an optional attribute.
* </p>
*
* @author cooper
@ -90,20 +93,24 @@ public class Category implements Serializable {
}
/**
* label is the human readable label that can be displayed in end user applications. It is an optional attribute.
* label is the human readable label that can be displayed in end user applications. It is an
* optional attribute.
*
* @return label is the human readable label that can be displayed in end user applications. It is an optional attribute.
* @return label is the human readable label that can be displayed in end user applications. It
* is an optional attribute.
*/
public String getLabel() {
return label;
}
/**
* scheme is the URI that identifies the categorization scheme. It is an optional attribute. If this attribute is not included, the default scheme is
* scheme is the URI that identifies the categorization scheme. It is an optional attribute. If
* this attribute is not included, the default scheme is
* 'http://search.yahoo.com/mrss/category_schema'.
*
* @return scheme is the URI that identifies the categorization scheme. It is an optional attribute. If this attribute is not included, the default scheme
* is 'http://search.yahoo.com/mrss/category_schema'.
* @return scheme is the URI that identifies the categorization scheme. It is an optional
* attribute. If this attribute is not included, the default scheme is
* 'http://search.yahoo.com/mrss/category_schema'.
*/
public String getScheme() {
return scheme;

16
src/main/java/org/rometools/feed/module/mediarss/types/Credit.java
View file

@ -32,9 +32,10 @@ import com.sun.syndication.feed.impl.ToStringBean;
* <strong>&lt;media:credit&gt;</strong></p>
*
* <p>
* Notable entity and the contribution to the creation of the media object. Current entities can include people, companies, locations, etc. Specific entities
* can have multiple roles, and several entities can have the same role. These should appear as distinct &lt;media:credit&gt; elements. It has 2 optional
* attributes.
* Notable entity and the contribution to the creation of the media object. Current entities can
* include people, companies, locations, etc. Specific entities can have multiple roles, and several
* entities can have the same role. These should appear as distinct &lt;media:credit&gt; elements.
* It has 2 optional attributes.
* </p>
*
* <pre>
@ -45,8 +46,9 @@ import com.sun.syndication.feed.impl.ToStringBean;
* </p>
*
* <p>
* <em>scheme</em> is the URI that identifies the role scheme. It is an optional attribute. If this attribute is not included, the default scheme is 'urn:ebu'.
* See: European Broadcasting Union Role Codes.
* <em>scheme</em> is the URI that identifies the role scheme. It is an optional attribute. If this
* attribute is not included, the default scheme is 'urn:ebu'. See: European Broadcasting Union Role
* Codes.
* </p>
*
*
@ -78,7 +80,9 @@ import com.sun.syndication.feed.impl.ToStringBean;
* vocalist
* </pre>
* <p>
* Additional roles: <a href="http://www.ebu.ch/en/technical/metadata/specifications/role_codes.php">European Broadcasting Union Role Codes</a>
* Additional roles: <a
* href="http://www.ebu.ch/en/technical/metadata/specifications/role_codes.php">European
* Broadcasting Union Role Codes</a>
*
* @author cooper
*/

5
src/main/java/org/rometools/feed/module/mediarss/types/Expression.java
View file

@ -20,8 +20,9 @@ package org.rometools.feed.module.mediarss.types;
import java.io.Serializable;
/**
* expression determines if the object is a sample or the full version of the object, or even if it is a continuous stream (sample | full | nonstop). Default
* value is 'full'. It is an optional attribute.
* expression determines if the object is a sample or the full version of the object, or even if it
* is a continuous stream (sample | full | nonstop). Default value is 'full'. It is an optional
* attribute.
*/
public class Expression implements Serializable {
private static final long serialVersionUID = 1L;

6
src/main/java/org/rometools/feed/module/mediarss/types/Hash.java
View file

@ -32,7 +32,8 @@ import com.sun.syndication.feed.impl.ToStringBean;
* <strong>&lt;media:hash&gt;</strong></p>
*
* <p>
* This is the hash of the binary media file. It can appear multiple times as long as each instance is a different <em>algo</em>. It has 1 optional attribute.
* This is the hash of the binary media file. It can appear multiple times as long as each instance
* is a different <em>algo</em>. It has 1 optional attribute.
* </p>
* <p>
* </p>
@ -42,7 +43,8 @@ import com.sun.syndication.feed.impl.ToStringBean;
* </pre>
*
* <p>
* <em>algo</em> indicates the algorithm used to create the hash. Possible values are 'md5' and 'sha-1'. Default value is 'md5'. It is an optional attribute.
* <em>algo</em> indicates the algorithm used to create the hash. Possible values are 'md5' and
* 'sha-1'. Default value is 'md5'. It is an optional attribute.
*
* @author cooper
*/

182
src/main/java/org/rometools/feed/module/mediarss/types/MediaContent.java
View file

@ -29,9 +29,11 @@ import com.sun.syndication.feed.impl.ToStringBean;
/**
* <strong>&lt;media:content&gt;</strong></p>
* <p>
* &lt;media:content&gt; is a sub-element of either &lt;item&gt; or &lt;media:group&gt;.&nbsp;Media objects that are not the same content should not be included
* in the same &lt;media:group&gt; element.&nbsp;The sequence of these items implies the order of presentation. While many of the attributes appear to be
* audio/video specific, this element can be used to publish any type of media. It contains 14 attributes, most of which are optional.
* &lt;media:content&gt; is a sub-element of either &lt;item&gt; or &lt;media:group&gt;.&nbsp;Media
* objects that are not the same content should not be included in the same &lt;media:group&gt;
* element.&nbsp;The sequence of these items implies the order of presentation. While many of the
* attributes appear to be audio/video specific, this element can be used to publish any type of
* media. It contains 14 attributes, most of which are optional.
* </p>
*
* <pre>
@ -53,7 +55,8 @@ import com.sun.syndication.feed.impl.ToStringBean;
* </pre>
*
* <p>
* <em>url</em> should specify the direct url to the media object. If not included, a &lt;media:player&gt; element must be specified.
* <em>url</em> should specify the direct url to the media object. If not included, a
* &lt;media:player&gt; element must be specified.
* </p>
* <p>
* <em>fileSize</em> is the number of bytes of the media object. It is an optional attribute.
@ -63,31 +66,35 @@ import com.sun.syndication.feed.impl.ToStringBean;
* </p>
*
* <p>
* <em>medium</em> is the type of object (image | audio | video | document | executable). While this attribute can at times seem redundant if <em>type</em> is
* supplied, it is included because it simplifies decision making on the reader side, as well as flushes out any ambiguities between MIME type and object type.
* It is an optional attribute.
* <em>medium</em> is the type of object (image | audio | video | document | executable). While this
* attribute can at times seem redundant if <em>type</em> is supplied, it is included because it
* simplifies decision making on the reader side, as well as flushes out any ambiguities between
* MIME type and object type. It is an optional attribute.
* </p>
*
*
* <p>
* <em>isDefault</em> determines if this is the default object that should be used for the &lt;media:group&gt;. There should only be one default object per
* &lt;media:group&gt;. It is an optional attribute.
* <em>isDefault</em> determines if this is the default object that should be used for the
* &lt;media:group&gt;. There should only be one default object per &lt;media:group&gt;. It is an
* optional attribute.
* </p>
*
* <p>
* <em>expression</em> determines if the object is a sample or the full version of the object, or even if it is a continuous stream (sample | full | nonstop).
* Default value is 'full'. It is an optional attribute.
* <em>expression</em> determines if the object is a sample or the full version of the object, or
* even if it is a continuous stream (sample | full | nonstop). Default value is 'full'. It is an
* optional attribute.
* </p>
*
* <p>
* <em>bitrate</em> is the kilobits per second rate of media. It is an optional attribute.
* </p>
* <p>
* <em>framerate</em> is the number of frames per second for the media object. It is an optional attribute.
* <em>framerate</em> is the number of frames per second for the media object. It is an optional
* attribute.
* </p>
* <p>
* <em>samplingrate</em> is the number of samples per second taken to create the media object. It is expressed in thousands of samples per second (kHz). It is
* an optional attribute.
* <em>samplingrate</em> is the number of samples per second taken to create the media object. It is
* expressed in thousands of samples per second (kHz). It is an optional attribute.
* </p>
* <p>
* <em>channels</em> is number of audio channels in the media object. It is an optional attribute.
@ -108,20 +115,23 @@ import com.sun.syndication.feed.impl.ToStringBean;
* </p>
*
* <p>
* <em>lang</em> is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar to
* the <em>xml:lang</em> attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
* <em>lang</em> is the primary language encapsulated in the media object. Language codes possible
* are detailed in RFC 3066. This attribute is used similar to the <em>xml:lang</em> attribute
* detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
* </p>
*
*
* <p>
* These optional attributes, along with the optional elements below, contain the primary metadata entries needed to index and organize media content.
* Additional supported attributes for describing images, audio, and video may be added in future revisions of this document.
* These optional attributes, along with the optional elements below, contain the primary metadata
* entries needed to index and organize media content. Additional supported attributes for
* describing images, audio, and video may be added in future revisions of this document.
* </p>
*
* @author Nathanial X. Freitas
*
* MediaContent corresponds to the <madia:content> element defined within the MediaRSS specification. There may be one or more <media:content> instances
* within each instance of an <item> within an RSS 2.0 document.
* MediaContent corresponds to the <madia:content> element defined within the MediaRSS
* specification. There may be one or more <media:content> instances within each instance of
* an <item> within an RSS 2.0 document.
*/
public class MediaContent implements Serializable {
private static final long serialVersionUID = 1L;
@ -131,7 +141,8 @@ public class MediaContent implements Serializable {
private Float samplingrate = null;
/*
* private variable for storing instances of Thumbnail class each MediaContent can have zero to many thumbnails
* private variable for storing instances of Thumbnail class each MediaContent can have zero to
* many thumbnails
*/
private Integer audioChannels = null;
@ -178,7 +189,8 @@ public class MediaContent implements Serializable {
/**
* channels is number of audio channels in the media object. It is an optional attribute.
*
* @param audioChannels channels is number of audio channels in the media object. It is an optional attribute.
* @param audioChannels channels is number of audio channels in the media object. It is an
* optional attribute.
*/
public void setAudioChannels(final Integer audioChannels) {
this.audioChannels = audioChannels;
@ -187,7 +199,8 @@ public class MediaContent implements Serializable {
/**
* channels is number of audio channels in the media object. It is an optional attribute.
*
* @return channels is number of audio channels in the media object. It is an optional attribute.
* @return channels is number of audio channels in the media object. It is an optional
* attribute.
*/
public Integer getAudioChannels() {
return audioChannels;
@ -212,22 +225,24 @@ public class MediaContent implements Serializable {
}
/**
* isDefault determines if this is the default object that should be used for the <media:group>. There should only be one default object per <media:group>.
* It is an optional attribute.
* isDefault determines if this is the default object that should be used for the <media:group>.
* There should only be one default object per <media:group>. It is an optional attribute.
*
* @param defaultContent isDefault determines if this is the default object that should be used for the <media:group>. There should only be one default
* object per <media:group>. It is an optional attribute.
* @param defaultContent isDefault determines if this is the default object that should be used
* for the <media:group>. There should only be one default object per <media:group>.
* It is an optional attribute.
*/
public void setDefaultContent(final boolean defaultContent) {
this.defaultContent = defaultContent;
}
/**
* isDefault determines if this is the default object that should be used for the <media:group>. There should only be one default object per <media:group>.
* It is an optional attribute.
* isDefault determines if this is the default object that should be used for the <media:group>.
* There should only be one default object per <media:group>. It is an optional attribute.
*
* @return isDefault determines if this is the default object that should be used for the <media:group>. There should only be one default object per
* <media:group>. It is an optional attribute.
* @return isDefault determines if this is the default object that should be used for the
* <media:group>. There should only be one default object per <media:group>. It is an
* optional attribute.
*/
public boolean isDefaultContent() {
return defaultContent;
@ -236,7 +251,8 @@ public class MediaContent implements Serializable {
/**
* duration is the number of seconds the media object plays. It is an optional attribute.
*
* @param duration duration is the number of seconds the media object plays. It is an optional attribute.
* @param duration duration is the number of seconds the media object plays. It is an optional
* attribute.
*/
public void setDuration(final Long duration) {
this.duration = duration;
@ -245,29 +261,34 @@ public class MediaContent implements Serializable {
/**
* duration is the number of seconds the media object plays. It is an optional attribute.
*
* @return duration is the number of seconds the media object plays. It is an optional attribute.
* @return duration is the number of seconds the media object plays. It is an optional
* attribute.
*/
public Long getDuration() {
return duration;
}
/**
* expression determines if the object is a sample or the full version of the object, or even if it is a continuous stream (sample | full | nonstop).
* Default value is 'full'. It is an optional attribute.
* expression determines if the object is a sample or the full version of the object, or even if
* it is a continuous stream (sample | full | nonstop). Default value is 'full'. It is an
* optional attribute.
*
* @param expression expression determines if the object is a sample or the full version of the object, or even if it is a continuous stream (sample | full
* | nonstop). Default value is 'full'. It is an optional attribute.
* @param expression expression determines if the object is a sample or the full version of the
* object, or even if it is a continuous stream (sample | full | nonstop). Default
* value is 'full'. It is an optional attribute.
*/
public void setExpression(final Expression expression) {
this.expression = expression;
}
/**
* expression determines if the object is a sample or the full version of the object, or even if it is a continuous stream (sample | full | nonstop).
* Default value is 'full'. It is an optional attribute.
* expression determines if the object is a sample or the full version of the object, or even if
* it is a continuous stream (sample | full | nonstop). Default value is 'full'. It is an
* optional attribute.
*
* @return expression determines if the object is a sample or the full version of the object, or even if it is a continuous stream (sample | full |
* nonstop). Default value is 'full'. It is an optional attribute.
* @return expression determines if the object is a sample or the full version of the object, or
* even if it is a continuous stream (sample | full | nonstop). Default value is 'full'.
* It is an optional attribute.
*/
public Expression getExpression() {
return expression;
@ -293,18 +314,22 @@ public class MediaContent implements Serializable {
}
/**
* framerate is the number of frames per second for the media object. It is an optional attribute.
* framerate is the number of frames per second for the media object. It is an optional
* attribute.
*
* @param framerate framerate is the number of frames per second for the media object. It is an optional attribute.
* @param framerate framerate is the number of frames per second for the media object. It is an
* optional attribute.
*/
public void setFramerate(final Float framerate) {
this.framerate = framerate;
}
/**
* framerate is the number of frames per second for the media object. It is an optional attribute.
* framerate is the number of frames per second for the media object. It is an optional
* attribute.
*
* @return framerate is the number of frames per second for the media object. It is an optional attribute.
* @return framerate is the number of frames per second for the media object. It is an optional
* attribute.
*/
public Float getFramerate() {
return framerate;
@ -329,22 +354,28 @@ public class MediaContent implements Serializable {
}
/**
* lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar to the
* xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
* lang is the primary language encapsulated in the media object. Language codes possible are
* detailed in RFC 3066. This attribute is used similar to the xml:lang attribute detailed in
* the XML 1.0 Specification (Third Edition). It is an optional attribute.
*
* @param language lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used
* similar to the xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
* @param language lang is the primary language encapsulated in the media object. Language codes
* possible are detailed in RFC 3066. This attribute is used similar to the xml:lang
* attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional
* attribute.
*/
public void setLanguage(final String language) {
this.language = language;
}
/**
* lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar to the
* xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
* lang is the primary language encapsulated in the media object. Language codes possible are
* detailed in RFC 3066. This attribute is used similar to the xml:lang attribute detailed in
* the XML 1.0 Specification (Third Edition). It is an optional attribute.
*
* @return lang is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar
* to the xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
* @return lang is the primary language encapsulated in the media object. Language codes
* possible are detailed in RFC 3066. This attribute is used similar to the xml:lang
* attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional
* attribute.
*/
public String getLanguage() {
return language;
@ -389,22 +420,26 @@ public class MediaContent implements Serializable {
/**
* <strong>&lt;media:player&gt;</strong></p>
* <p>
* Allows the media object to be accessed through a web browser media player console. This element is required only if a direct media <em>url</em> attribute
* is not specified in the &lt;media:content&gt; element. It has 1 required attribute, and 2 optional attributes.
* Allows the media object to be accessed through a web browser media player console. This
* element is required only if a direct media <em>url</em> attribute is not specified in the
* &lt;media:content&gt; element. It has 1 required attribute, and 2 optional attributes.
* </p>
*
* <pre>
* &lt;media:player url="http://www.foo.com/player?id=1111" height="200" width="400" /&gt;
* </pre>
* <p>
* <em>url</em> is the url of the player console that plays the media. It is a required attribute.
* <em>url</em> is the url of the player console that plays the media. It is a required
* attribute.
* </p>
*
* <p>
* <em>height</em> is the height of the browser window that the <em>url</em> should be opened in. It is an optional attribute.
* <em>height</em> is the height of the browser window that the <em>url</em> should be opened
* in. It is an optional attribute.
* </p>
* <p>
* <em>width</em> is the width of the browser window that the <em>url</em> should be opened in. It is an optional attribute.
* <em>width</em> is the width of the browser window that the <em>url</em> should be opened in.
* It is an optional attribute.
* </p>
*
* <p>
@ -418,22 +453,26 @@ public class MediaContent implements Serializable {
/**
* <strong>&lt;media:player&gt;</strong></p>
* <p>
* Allows the media object to be accessed through a web browser media player console. This element is required only if a direct media <em>url</em> attribute
* is not specified in the &lt;media:content&gt; element. It has 1 required attribute, and 2 optional attributes.
* Allows the media object to be accessed through a web browser media player console. This
* element is required only if a direct media <em>url</em> attribute is not specified in the
* &lt;media:content&gt; element. It has 1 required attribute, and 2 optional attributes.
* </p>
*
* <pre>
* &lt;media:player url="http://www.foo.com/player?id=1111" height="200" width="400" /&gt;
* </pre>
* <p>
* <em>url</em> is the url of the player console that plays the media. It is a required attribute.
* <em>url</em> is the url of the player console that plays the media. It is a required
* attribute.
* </p>
*
* <p>
* <em>height</em> is the height of the browser window that the <em>url</em> should be opened in. It is an optional attribute.
* <em>height</em> is the height of the browser window that the <em>url</em> should be opened
* in. It is an optional attribute.
* </p>
* <p>
* <em>width</em> is the width of the browser window that the <em>url</em> should be opened in. It is an optional attribute.
* <em>width</em> is the width of the browser window that the <em>url</em> should be opened in.
* It is an optional attribute.
* </p>
*
* @return PlayerReference for the item.
@ -465,22 +504,23 @@ public class MediaContent implements Serializable {
}
/**
* samplingrate is the number of samples per second taken to create the media object. It is expressed in thousands of samples per second (kHz). It is an
* optional attribute.
* samplingrate is the number of samples per second taken to create the media object. It is
* expressed in thousands of samples per second (kHz). It is an optional attribute.
*
* @param samplingrate samplingrate is the number of samples per second taken to create the media object. It is expressed in thousands of samples per second
* (kHz). It is an optional attribute.
* @param samplingrate samplingrate is the number of samples per second taken to create the
* media object. It is expressed in thousands of samples per second (kHz). It is an
* optional attribute.
*/
public void setSamplingrate(final Float samplingrate) {
this.samplingrate = samplingrate;
}
/**
* samplingrate is the number of samples per second taken to create the media object. It is expressed in thousands of samples per second (kHz). It is an
* optional attribute.
* samplingrate is the number of samples per second taken to create the media object. It is
* expressed in thousands of samples per second (kHz). It is an optional attribute.
*
* @return samplingrate is the number of samples per second taken to create the media object. It is expressed in thousands of samples per second (kHz). It
* is an optional attribute.
* @return samplingrate is the number of samples per second taken to create the media object. It
* is expressed in thousands of samples per second (kHz). It is an optional attribute.
*/
public Float getSamplingrate() {
return samplingrate;

7
src/main/java/org/rometools/feed/module/mediarss/types/MediaGroup.java
View file

@ -31,9 +31,10 @@ import com.sun.syndication.feed.impl.ToStringBean;
/**
* <strong>&lt;media:group&gt;</strong></p>
* <p>
* &lt;media:group&gt; is a sub-element of &lt;item&gt;. It allows grouping of &lt;media:content&gt; elements that are effectively the same content, yet
* different representations.&nbsp;For instance: the same song recorded in both the WAV and MP3 format. It's an optional element that must only be used for this
* purpose.
* &lt;media:group&gt; is a sub-element of &lt;item&gt;. It allows grouping of &lt;media:content&gt;
* elements that are effectively the same content, yet different representations.&nbsp;For instance:
* the same song recorded in both the WAV and MP3 format. It's an optional element that must only be
* used for this purpose.
* </p>
*
* @author cooper

304
src/main/java/org/rometools/feed/module/mediarss/types/Metadata.java
View file

@ -35,22 +35,25 @@ import com.sun.syndication.feed.impl.ToStringBean;
*
* Optional Elements
* <p>
* The following elements are optional and may appear as sub-elements of &lt;channel&gt;, &lt;item&gt;, &lt;media:content&gt; and/or &lt;media:group&gt;.
* The following elements are optional and may appear as sub-elements of &lt;channel&gt;,
* &lt;item&gt;, &lt;media:content&gt; and/or &lt;media:group&gt;.
*
*
* </p>
* <p>
*
* When an element appears at a shallow level, such as &lt;channel&gt; or &lt;item&gt;, it means that the element should be applied to every media object within
* its scope.
* When an element appears at a shallow level, such as &lt;channel&gt; or &lt;item&gt;, it means
* that the element should be applied to every media object within its scope.
* </p>
*
*
* <p>
* Duplicated elements appearing at deeper levels of the document tree have higher priority over other levels.
* Duplicated elements appearing at deeper levels of the document tree have higher priority over
* other levels.
*
* For example, &lt;media:content&gt; level elements are favored over &lt;item&gt; level elements. The priority level is listed from strongest to weakest:
* &lt;media:content&gt;, &lt;media:group&gt;, &lt;item&gt;, &lt;channel&gt;.
* For example, &lt;media:content&gt; level elements are favored over &lt;item&gt; level elements.
* The priority level is listed from strongest to weakest: &lt;media:content&gt;,
* &lt;media:group&gt;, &lt;item&gt;, &lt;channel&gt;.
* </p>
*
* @author cooper
@ -81,7 +84,8 @@ public class Metadata implements Cloneable, Serializable {
/**
* <strong>&lt;media:category&gt;</strong></p>
* <p>
* Allows a taxonomy to be set that gives an indication of the type of media content, and its particular contents. It has 2 optional attributes.
* Allows a taxonomy to be set that gives an indication of the type of media content, and its
* particular contents. It has 2 optional attributes.
* </p>
*
* <pre>
@ -97,12 +101,14 @@ public class Metadata implements Cloneable, Serializable {
* </pre>
*
* <p>
* <em>scheme</em> is the URI that identifies the categorization scheme. It is an optional attribute. If this attribute is not included, the default scheme
* is 'http://search.yahoo.com/mrss/category_schema'.
* <em>scheme</em> is the URI that identifies the categorization scheme. It is an optional
* attribute. If this attribute is not included, the default scheme is
* 'http://search.yahoo.com/mrss/category_schema'.
* </p>
*
* <p>
* <em>label</em> is the human readable label that can be displayed in end user applications. It is an optional attribute.
* <em>label</em> is the human readable label that can be displayed in end user applications. It
* is an optional attribute.
* </p>
*
* @param categories categories for the item
@ -114,7 +120,8 @@ public class Metadata implements Cloneable, Serializable {
/**
* <strong>&lt;media:category&gt;</strong></p>
* <p>
* Allows a taxonomy to be set that gives an indication of the type of media content, and its particular contents. It has 2 optional attributes.
* Allows a taxonomy to be set that gives an indication of the type of media content, and its
* particular contents. It has 2 optional attributes.
* </p>
*
* <pre>
@ -130,12 +137,14 @@ public class Metadata implements Cloneable, Serializable {
* </pre>
*
* <p>
* <em>scheme</em> is the URI that identifies the categorization scheme. It is an optional attribute. If this attribute is not included, the default scheme
* is 'http://search.yahoo.com/mrss/category_schema'.
* <em>scheme</em> is the URI that identifies the categorization scheme. It is an optional
* attribute. If this attribute is not included, the default scheme is
* 'http://search.yahoo.com/mrss/category_schema'.
* </p>
*
* <p>
* <em>label</em> is the human readable label that can be displayed in end user applications. It is an optional attribute.
* <em>label</em> is the human readable label that can be displayed in end user applications. It
* is an optional attribute.
* </p>
*
* @return categories for the item.
@ -154,8 +163,9 @@ public class Metadata implements Cloneable, Serializable {
* &lt;media:copyright url="http://blah.com/additional-info.html"&gt;2005 FooBar Media&lt;/media:copyright&gt;
* </pre>
* <p>
* <em>url</em> is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the
* Creative Commons module should be used instead. It is an optional attribute.
* <em>url</em> is the url for a terms of use page or additional copyright information. If the
* media is operating under a Creative Commons license, the Creative Commons module should be
* used instead. It is an optional attribute.
* </p>
*
* @param copyright copyright text
@ -174,8 +184,9 @@ public class Metadata implements Cloneable, Serializable {
* &lt;media:copyright url="http://blah.com/additional-info.html"&gt;2005 FooBar Media&lt;/media:copyright&gt;
* </pre>
* <p>
* <em>url</em> is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the
* Creative Commons module should be used instead. It is an optional attribute.
* <em>url</em> is the url for a terms of use page or additional copyright information. If the
* media is operating under a Creative Commons license, the Creative Commons module should be
* used instead. It is an optional attribute.
* </p>
*
* @return Copyright text
@ -194,8 +205,9 @@ public class Metadata implements Cloneable, Serializable {
* &lt;media:copyright url="http://blah.com/additional-info.html"&gt;2005 FooBar Media&lt;/media:copyright&gt;
* </pre>
* <p>
* <em>url</em> is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the
* Creative Commons module should be used instead. It is an optional attribute.
* <em>url</em> is the url for a terms of use page or additional copyright information. If the
* media is operating under a Creative Commons license, the Creative Commons module should be
* used instead. It is an optional attribute.
* </p>
*
* @param copyrightUrl link to more copyright information.
@ -214,8 +226,9 @@ public class Metadata implements Cloneable, Serializable {
* &lt;media:copyright url="http://blah.com/additional-info.html"&gt;2005 FooBar Media&lt;/media:copyright&gt;
* </pre>
* <p>
* <em>url</em> is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the
* Creative Commons module should be used instead. It is an optional attribute.
* <em>url</em> is the url for a terms of use page or additional copyright information. If the
* media is operating under a Creative Commons license, the Creative Commons module should be
* used instead. It is an optional attribute.
* </p>
*
* @return Link to more copyright information.
@ -228,9 +241,10 @@ public class Metadata implements Cloneable, Serializable {
* <strong>&lt;media:credit&gt;</strong></p>
*
* <p>
* Notable entity and the contribution to the creation of the media object. Current entities can include people, companies, locations, etc. Specific
* entities can have multiple roles, and several entities can have the same role. These should appear as distinct &lt;media:credit&gt; elements. It has 2
* optional attributes.
* Notable entity and the contribution to the creation of the media object. Current entities can
* include people, companies, locations, etc. Specific entities can have multiple roles, and
* several entities can have the same role. These should appear as distinct &lt;media:credit&gt;
* elements. It has 2 optional attributes.
* </p>
*
* <pre>
@ -241,8 +255,9 @@ public class Metadata implements Cloneable, Serializable {
* </p>
*
* <p>
* <em>scheme</em> is the URI that identifies the role scheme. It is an optional attribute. If this attribute is not included, the default scheme is
* 'urn:ebu'. See: European Broadcasting Union Role Codes.
* <em>scheme</em> is the URI that identifies the role scheme. It is an optional attribute. If
* this attribute is not included, the default scheme is 'urn:ebu'. See: European Broadcasting
* Union Role Codes.
* </p>
*
*
@ -274,7 +289,9 @@ public class Metadata implements Cloneable, Serializable {
* vocalist
* </pre>
* <p>
* Additional roles: <a href="http://www.ebu.ch/en/technical/metadata/specifications/role_codes.php">European Broadcasting Union Role Codes</a>
* Additional roles: <a
* href="http://www.ebu.ch/en/technical/metadata/specifications/role_codes.php">European
* Broadcasting Union Role Codes</a>
*
* @param credits credits for the item.
*/
@ -286,9 +303,10 @@ public class Metadata implements Cloneable, Serializable {
* <strong>&lt;media:credit&gt;</strong></p>
*
* <p>
* Notable entity and the contribution to the creation of the media object. Current entities can include people, companies, locations, etc. Specific
* entities can have multiple roles, and several entities can have the same role. These should appear as distinct &lt;media:credit&gt; elements. It has 2
* optional attributes.
* Notable entity and the contribution to the creation of the media object. Current entities can
* include people, companies, locations, etc. Specific entities can have multiple roles, and
* several entities can have the same role. These should appear as distinct &lt;media:credit&gt;
* elements. It has 2 optional attributes.
* </p>
*
* <pre>
@ -299,8 +317,9 @@ public class Metadata implements Cloneable, Serializable {
* </p>
*
* <p>
* <em>scheme</em> is the URI that identifies the role scheme. It is an optional attribute. If this attribute is not included, the default scheme is
* 'urn:ebu'. See: European Broadcasting Union Role Codes.
* <em>scheme</em> is the URI that identifies the role scheme. It is an optional attribute. If
* this attribute is not included, the default scheme is 'urn:ebu'. See: European Broadcasting
* Union Role Codes.
* </p>
*
*
@ -332,7 +351,9 @@ public class Metadata implements Cloneable, Serializable {
* vocalist
* </pre>
* <p>
* Additional roles: <a href="http://www.ebu.ch/en/technical/metadata/specifications/role_codes.php">European Broadcasting Union Role Codes</a>
* Additional roles: <a
* href="http://www.ebu.ch/en/technical/metadata/specifications/role_codes.php">European
* Broadcasting Union Role Codes</a>
*
* @return credits for the time.
*/
@ -343,15 +364,17 @@ public class Metadata implements Cloneable, Serializable {
/**
* <strong>&lt;media:description&gt;</strong></p>
* <p>
* Short description describing the media object typically a sentence in length. It has 1 optional attribute.
* Short description describing the media object typically a sentence in length. It has 1
* optional attribute.
* </p>
*
* <pre>
* &lt;media:description type="plain"&gt;This was some really bizarre band I listened to as a young lad.&lt;/media:description&gt;
* </pre>
* <p>
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be
* entity-encoded. It is an optional attribute.
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or
* 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional
* attribute.
* </p>
*
* @param description value of the description
@ -363,15 +386,17 @@ public class Metadata implements Cloneable, Serializable {
/**
* <strong>&lt;media:description&gt;</strong></p>
* <p>
* Short description describing the media object typically a sentence in length. It has 1 optional attribute.
* Short description describing the media object typically a sentence in length. It has 1
* optional attribute.
* </p>
*
* <pre>
* &lt;media:description type="plain"&gt;This was some really bizarre band I listened to as a young lad.&lt;/media:description&gt;
* </pre>
* <p>
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be
* entity-encoded. It is an optional attribute.
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or
* 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional
* attribute.
* </p>
*
* @return value of the description
@ -383,15 +408,17 @@ public class Metadata implements Cloneable, Serializable {
/**
* <strong>&lt;media:description&gt;</strong></p>
* <p>
* Short description describing the media object typically a sentence in length. It has 1 optional attribute.
* Short description describing the media object typically a sentence in length. It has 1
* optional attribute.
* </p>
*
* <pre>
* &lt;media:description type="plain"&gt;This was some really bizarre band I listened to as a young lad.&lt;/media:description&gt;
* </pre>
* <p>
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be
* entity-encoded. It is an optional attribute.
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or
* 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional
* attribute.
* </p>
*
* @param descriptionType type of the description.
@ -403,15 +430,17 @@ public class Metadata implements Cloneable, Serializable {
/**
* <strong>&lt;media:description&gt;</strong></p>
* <p>
* Short description describing the media object typically a sentence in length. It has 1 optional attribute.
* Short description describing the media object typically a sentence in length. It has 1
* optional attribute.
* </p>
*
* <pre>
* &lt;media:description type="plain"&gt;This was some really bizarre band I listened to as a young lad.&lt;/media:description&gt;
* </pre>
* <p>
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be
* entity-encoded. It is an optional attribute.
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or
* 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional
* attribute.
* </p>
*
* @return type of the description
@ -424,8 +453,8 @@ public class Metadata implements Cloneable, Serializable {
* <strong>&lt;media:hash&gt;</strong></p>
*
* <p>
* This is the hash of the binary media file. It can appear multiple times as long as each instance is a different <em>algo</em>. It has 1 optional
* attribute.
* This is the hash of the binary media file. It can appear multiple times as long as each
* instance is a different <em>algo</em>. It has 1 optional attribute.
* </p>
* <p>
* </p>
@ -435,8 +464,8 @@ public class Metadata implements Cloneable, Serializable {
* </pre>
*
* <p>
* <em>algo</em> indicates the algorithm used to create the hash. Possible values are 'md5' and 'sha-1'. Default value is 'md5'. It is an optional
* attribute.
* <em>algo</em> indicates the algorithm used to create the hash. Possible values are 'md5' and
* 'sha-1'. Default value is 'md5'. It is an optional attribute.
*
* @param hash sets the hash for the item.
*/
@ -448,8 +477,8 @@ public class Metadata implements Cloneable, Serializable {
* <strong>&lt;media:hash&gt;</strong></p>
*
* <p>
* This is the hash of the binary media file. It can appear multiple times as long as each instance is a different <em>algo</em>. It has 1 optional
* attribute.
* This is the hash of the binary media file. It can appear multiple times as long as each
* instance is a different <em>algo</em>. It has 1 optional attribute.
* </p>
* <p>
* </p>
@ -459,8 +488,8 @@ public class Metadata implements Cloneable, Serializable {
* </pre>
*
* <p>
* <em>algo</em> indicates the algorithm used to create the hash. Possible values are 'md5' and 'sha-1'. Default value is 'md5'. It is an optional
* attribute.
* <em>algo</em> indicates the algorithm used to create the hash. Possible values are 'md5' and
* 'sha-1'. Default value is 'md5'. It is an optional attribute.
*
* @return returns a Hash object for the item.
*/
@ -471,7 +500,8 @@ public class Metadata implements Cloneable, Serializable {
/**
* <strong>&lt;media:keywords&gt;</strong></p>
* <p>
* Highly relevant keywords describing the media object with typically a maximum of ten words. The keywords and phrases should be comma delimited.
* Highly relevant keywords describing the media object with typically a maximum of ten words.
* The keywords and phrases should be comma delimited.
* </p>
*
* <pre>
@ -487,7 +517,8 @@ public class Metadata implements Cloneable, Serializable {
/**
* <strong>&lt;media:keywords&gt;</strong></p>
* <p>
* Highly relevant keywords describing the media object with typically a maximum of ten words. The keywords and phrases should be comma delimited.
* Highly relevant keywords describing the media object with typically a maximum of ten words.
* The keywords and phrases should be comma delimited.
* </p>
*
* <pre>
@ -505,8 +536,8 @@ public class Metadata implements Cloneable, Serializable {
*
*
* <p>
* This allows the permissible audience to be declared. If this element is not included, it assumes that no restrictions are necessary. It has one optional
* attribute.
* This allows the permissible audience to be declared. If this element is not included, it
* assumes that no restrictions are necessary. It has one optional attribute.
* </p>
*
* <pre>
@ -519,8 +550,8 @@ public class Metadata implements Cloneable, Serializable {
*
*
* <p>
* <em>scheme</em> is the URI that identifies the rating scheme. It is an optional attribute. If this attribute is not included, the default scheme is
* urn:simple (adult | nonadult).
* <em>scheme</em> is the URI that identifies the rating scheme. It is an optional attribute. If
* this attribute is not included, the default scheme is urn:simple (adult | nonadult).
* </p>
*
* <p>
@ -536,8 +567,8 @@ public class Metadata implements Cloneable, Serializable {
*
*
* <p>
* This allows the permissible audience to be declared. If this element is not included, it assumes that no restrictions are necessary. It has one optional
* attribute.
* This allows the permissible audience to be declared. If this element is not included, it
* assumes that no restrictions are necessary. It has one optional attribute.
* </p>
*
* <pre>
@ -550,8 +581,8 @@ public class Metadata implements Cloneable, Serializable {
*
*
* <p>
* <em>scheme</em> is the URI that identifies the rating scheme. It is an optional attribute. If this attribute is not included, the default scheme is
* urn:simple (adult | nonadult).
* <em>scheme</em> is the URI that identifies the rating scheme. It is an optional attribute. If
* this attribute is not included, the default scheme is urn:simple (adult | nonadult).
* </p>
*
* <p>
@ -566,11 +597,14 @@ public class Metadata implements Cloneable, Serializable {
* <strong>&lt;media:restriction&gt; </strong></p>
*
* <p>
* Allows restrictions to be placed on the aggregator rendering the media in the feed. Currently, restrictions are based on distributor (uri) and country
* codes. This element is purely informational and no obligation can be assumed or implied. Only one &lt;media:restriction&gt; element of the same
* <em>type</em> can be applied to a media object - all others will be ignored.&nbsp;Entities in this element should be space separated. To allow the
* producer to explicitly declare his/her intentions, two literals are reserved: 'all', 'none'. These literals can only be used once. This element has 1
* required attribute, and 1 optional attribute (with strict requirements for its exclusion).
* Allows restrictions to be placed on the aggregator rendering the media in the feed.
* Currently, restrictions are based on distributor (uri) and country codes. This element is
* purely informational and no obligation can be assumed or implied. Only one
* &lt;media:restriction&gt; element of the same <em>type</em> can be applied to a media object
* - all others will be ignored.&nbsp;Entities in this element should be space separated. To
* allow the producer to explicitly declare his/her intentions, two literals are reserved:
* 'all', 'none'. These literals can only be used once. This element has 1 required attribute,
* and 1 optional attribute (with strict requirements for its exclusion).
* </p>
*
* <pre>
@ -578,8 +612,9 @@ public class Metadata implements Cloneable, Serializable {
* </pre>
*
* <p>
* <em>relationship</em> indicates the type of relationship that the restriction represents (allow | deny). In the example above, the media object should
* only be syndicated in Australia and the United States. It is a required attribute.
* <em>relationship</em> indicates the type of relationship that the restriction represents
* (allow | deny). In the example above, the media object should only be syndicated in Australia
* and the United States. It is a required attribute.
* </p>
*
* @param restrictions restrictions for the item.
@ -592,11 +627,14 @@ public class Metadata implements Cloneable, Serializable {
* <strong>&lt;media:restriction&gt; </strong></p>
*
* <p>
* Allows restrictions to be placed on the aggregator rendering the media in the feed. Currently, restrictions are based on distributor (uri) and country
* codes. This element is purely informational and no obligation can be assumed or implied. Only one &lt;media:restriction&gt; element of the same
* <em>type</em> can be applied to a media object - all others will be ignored.&nbsp;Entities in this element should be space separated. To allow the
* producer to explicitly declare his/her intentions, two literals are reserved: 'all', 'none'. These literals can only be used once. This element has 1
* required attribute, and 1 optional attribute (with strict requirements for its exclusion).
* Allows restrictions to be placed on the aggregator rendering the media in the feed.
* Currently, restrictions are based on distributor (uri) and country codes. This element is
* purely informational and no obligation can be assumed or implied. Only one
* &lt;media:restriction&gt; element of the same <em>type</em> can be applied to a media object
* - all others will be ignored.&nbsp;Entities in this element should be space separated. To
* allow the producer to explicitly declare his/her intentions, two literals are reserved:
* 'all', 'none'. These literals can only be used once. This element has 1 required attribute,
* and 1 optional attribute (with strict requirements for its exclusion).
* </p>
*
* <pre>
@ -604,8 +642,9 @@ public class Metadata implements Cloneable, Serializable {
* </pre>
*
* <p>
* <em>relationship</em> indicates the type of relationship that the restriction represents (allow | deny). In the example above, the media object should
* only be syndicated in Australia and the United States. It is a required attribute.
* <em>relationship</em> indicates the type of relationship that the restriction represents
* (allow | deny). In the example above, the media object should only be syndicated in Australia
* and the United States. It is a required attribute.
* </p>
*
* @return restrictions for the item.
@ -617,9 +656,11 @@ public class Metadata implements Cloneable, Serializable {
/**
* <strong>&lt;media:text&gt;</strong></p>
* <p>
* Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content. Many of these elements are permitted to provide a time
* series of text. In such cases, it is encouraged, but not required, that the elements be grouped by language and appear in time sequence order based on
* the <em>start</em> time. Elements can have overlapping <em>start</em> and <em>end</em> times. It has 4 optional attributes.
* Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content.
* Many of these elements are permitted to provide a time series of text. In such cases, it is
* encouraged, but not required, that the elements be grouped by language and appear in time
* sequence order based on the <em>start</em> time. Elements can have overlapping <em>start</em>
* and <em>end</em> times. It has 4 optional attributes.
* </p>
*
* <pre>
@ -630,8 +671,9 @@ public class Metadata implements Cloneable, Serializable {
* end="00:00:17.000"&gt;By the dawn's early light&lt;/media:text&gt;
* </pre>
* <p>
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be
* entity-encoded. It is an optional attribute.
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or
* 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional
* attribute.
* </p>
*
*
@ -640,18 +682,22 @@ public class Metadata implements Cloneable, Serializable {
*
*
* <p>
* <em>lang</em> is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar
* to the xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
* <em>lang</em> is the primary language encapsulated in the media object. Language codes
* possible are detailed in RFC 3066. This attribute is used similar to the xml:lang attribute
* detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
* </p>
*
* <p>
* <em>start</em> specifies the start time offset that the text starts being relevant to the media object. An example of this would be for closed
* captioning. It uses the NTP time code format (see: the time attribute used in &lt;media:thumbnail&gt;).&nbsp;It is an optional attribute.
* <em>start</em> specifies the start time offset that the text starts being relevant to the
* media object. An example of this would be for closed captioning. It uses the NTP time code
* format (see: the time attribute used in &lt;media:thumbnail&gt;).&nbsp;It is an optional
* attribute.
* </p>
*
* <p>
* <em>end</em> specifies the end time that the text is relevant. If this attribute is not provided, and a <em>start</em> time is used, it is expected that
* the end time is either the end of the clip or the start of the next &lt;media:text&gt; element.
* <em>end</em> specifies the end time that the text is relevant. If this attribute is not
* provided, and a <em>start</em> time is used, it is expected that the end time is either the
* end of the clip or the start of the next &lt;media:text&gt; element.
*
* @param text text objects for the item.
*/
@ -662,9 +708,11 @@ public class Metadata implements Cloneable, Serializable {
/**
* <strong>&lt;media:text&gt;</strong></p>
* <p>
* Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content. Many of these elements are permitted to provide a time
* series of text. In such cases, it is encouraged, but not required, that the elements be grouped by language and appear in time sequence order based on
* the <em>start</em> time. Elements can have overlapping <em>start</em> and <em>end</em> times. It has 4 optional attributes.
* Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content.
* Many of these elements are permitted to provide a time series of text. In such cases, it is
* encouraged, but not required, that the elements be grouped by language and appear in time
* sequence order based on the <em>start</em> time. Elements can have overlapping <em>start</em>
* and <em>end</em> times. It has 4 optional attributes.
* </p>
*
* <pre>
@ -675,8 +723,9 @@ public class Metadata implements Cloneable, Serializable {
* end="00:00:17.000"&gt;By the dawn's early light&lt;/media:text&gt;
* </pre>
* <p>
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be
* entity-encoded. It is an optional attribute.
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or
* 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional
* attribute.
* </p>
*
*
@ -685,18 +734,22 @@ public class Metadata implements Cloneable, Serializable {
*
*
* <p>
* <em>lang</em> is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar
* to the xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
* <em>lang</em> is the primary language encapsulated in the media object. Language codes
* possible are detailed in RFC 3066. This attribute is used similar to the xml:lang attribute
* detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
* </p>
*
* <p>
* <em>start</em> specifies the start time offset that the text starts being relevant to the media object. An example of this would be for closed
* captioning. It uses the NTP time code format (see: the time attribute used in &lt;media:thumbnail&gt;).&nbsp;It is an optional attribute.
* <em>start</em> specifies the start time offset that the text starts being relevant to the
* media object. An example of this would be for closed captioning. It uses the NTP time code
* format (see: the time attribute used in &lt;media:thumbnail&gt;).&nbsp;It is an optional
* attribute.
* </p>
*
* <p>
* <em>end</em> specifies the end time that the text is relevant. If this attribute is not provided, and a <em>start</em> time is used, it is expected that
* the end time is either the end of the clip or the start of the next &lt;media:text&gt; element.
* <em>end</em> specifies the end time that the text is relevant. If this attribute is not
* provided, and a <em>start</em> time is used, it is expected that the end time is either the
* end of the clip or the start of the next &lt;media:text&gt; element.
*
* @return Text objects for the item.
*/
@ -709,8 +762,9 @@ public class Metadata implements Cloneable, Serializable {
*
*
* <p>
* Allows particular images to be used as representative images for the media object. If multiple thumbnails are included, and time coding is not at play,
* it is assumed that the images are in order of importance. It has 1 required attribute and 3 optional attributes.
* Allows particular images to be used as representative images for the media object. If
* multiple thumbnails are included, and time coding is not at play, it is assumed that the
* images are in order of importance. It has 1 required attribute and 3 optional attributes.
* </p>
*
*
@ -732,9 +786,11 @@ public class Metadata implements Cloneable, Serializable {
*
*
* <p>
* <em>time</em> specifies the time offset in relation to the media object. Typically this is used when creating multiple keyframes within a single video.
* The format for this attribute should be in the DSM-CC's Normal Play Time (NTP) as used in RTSP [<a href="http://www.ietf.org/rfc/rfc2326.txt">RFC 2326
* 3.6 Normal Play Time</a>]. It is an optional attribute.
* <em>time</em> specifies the time offset in relation to the media object. Typically this is
* used when creating multiple keyframes within a single video. The format for this attribute
* should be in the DSM-CC's Normal Play Time (NTP) as used in RTSP [<a
* href="http://www.ietf.org/rfc/rfc2326.txt">RFC 2326 3.6 Normal Play Time</a>]. It is an
* optional attribute.
* </p>
*
* @param thumbnail thumbnails for the image
@ -748,8 +804,9 @@ public class Metadata implements Cloneable, Serializable {
*
*
* <p>
* Allows particular images to be used as representative images for the media object. If multiple thumbnails are included, and time coding is not at play,
* it is assumed that the images are in order of importance. It has 1 required attribute and 3 optional attributes.
* Allows particular images to be used as representative images for the media object. If
* multiple thumbnails are included, and time coding is not at play, it is assumed that the
* images are in order of importance. It has 1 required attribute and 3 optional attributes.
* </p>
*
*
@ -771,9 +828,11 @@ public class Metadata implements Cloneable, Serializable {
*
*
* <p>
* <em>time</em> specifies the time offset in relation to the media object. Typically this is used when creating multiple keyframes within a single video.
* The format for this attribute should be in the DSM-CC's Normal Play Time (NTP) as used in RTSP [<a href="http://www.ietf.org/rfc/rfc2326.txt">RFC 2326
* 3.6 Normal Play Time</a>]. It is an optional attribute.
* <em>time</em> specifies the time offset in relation to the media object. Typically this is
* used when creating multiple keyframes within a single video. The format for this attribute
* should be in the DSM-CC's Normal Play Time (NTP) as used in RTSP [<a
* href="http://www.ietf.org/rfc/rfc2326.txt">RFC 2326 3.6 Normal Play Time</a>]. It is an
* optional attribute.
* </p>
*
* @return Thumbnails for the image
@ -793,8 +852,9 @@ public class Metadata implements Cloneable, Serializable {
* </pre>
*
* <p>
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be
* entity-encoded. It is an optional attribute.
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or
* 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional
* attribute.
* </p>
*
* @param title Value of the title
@ -814,8 +874,9 @@ public class Metadata implements Cloneable, Serializable {
* </pre>
*
* <p>
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be
* entity-encoded. It is an optional attribute.
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or
* 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional
* attribute.
* </p>
*
* @return value of the title.
@ -835,8 +896,9 @@ public class Metadata implements Cloneable, Serializable {
* </pre>
*
* <p>
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be
* entity-encoded. It is an optional attribute.
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or
* 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional
* attribute.
* </p>
*
* @param titleType type of the title.
@ -856,8 +918,9 @@ public class Metadata implements Cloneable, Serializable {
* </pre>
*
* <p>
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be
* entity-encoded. It is an optional attribute.
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or
* 'html'. Default value is 'plain'. All html must be entity-encoded. It is an optional
* attribute.
* </p>
*
* @return type of the title
@ -876,8 +939,9 @@ public class Metadata implements Cloneable, Serializable {
* &lt;media:copyright url="http://blah.com/additional-info.html"&gt;2005 FooBar Media&lt;/media:copyright&gt;
* </pre>
* <p>
* <em>url</em> is the url for a terms of use page or additional copyright information. If the media is operating under a Creative Commons license, the
* Creative Commons module should be used instead. It is an optional attribute.
* <em>url</em> is the url for a terms of use page or additional copyright information. If the
* media is operating under a Creative Commons license, the Creative Commons module should be
* used instead. It is an optional attribute.
* </p>
*
* @return Link to more copyright information.

11
src/main/java/org/rometools/feed/module/mediarss/types/PlayerReference.java
View file

@ -32,8 +32,9 @@ import com.sun.syndication.feed.impl.ToStringBean;
*
* <strong>&lt;media:player&gt;</strong></p>
* <p>
* Allows the media object to be accessed through a web browser media player console. This element is required only if a direct media <em>url</em> attribute is
* not specified in the &lt;media:content&gt; element. It has 1 required attribute, and 2 optional attributes.
* Allows the media object to be accessed through a web browser media player console. This element
* is required only if a direct media <em>url</em> attribute is not specified in the
* &lt;media:content&gt; element. It has 1 required attribute, and 2 optional attributes.
* </p>
*
* <pre>
@ -44,10 +45,12 @@ import com.sun.syndication.feed.impl.ToStringBean;
* </p>
*
* <p>
* <em>height</em> is the height of the browser window that the <em>url</em> should be opened in. It is an optional attribute.
* <em>height</em> is the height of the browser window that the <em>url</em> should be opened in. It
* is an optional attribute.
* </p>
* <p>
* <em>width</em> is the width of the browser window that the <em>url</em> should be opened in. It is an optional attribute.
* <em>width</em> is the width of the browser window that the <em>url</em> should be opened in. It
* is an optional attribute.
* </p>
*
* @author cooper

8
src/main/java/org/rometools/feed/module/mediarss/types/Rating.java
View file

@ -30,8 +30,8 @@ import com.sun.syndication.feed.impl.ToStringBean;
*
*
* <p>
* This allows the permissible audience to be declared. If this element is not included, it assumes that no restrictions are necessary. It has one optional
* attribute.
* This allows the permissible audience to be declared. If this element is not included, it assumes
* that no restrictions are necessary. It has one optional attribute.
* </p>
*
* <pre>
@ -44,8 +44,8 @@ import com.sun.syndication.feed.impl.ToStringBean;
*
*
* <p>
* <em>scheme</em> is the URI that identifies the rating scheme. It is an optional attribute. If this attribute is not included, the default scheme is
* urn:simple (adult | nonadult).
* <em>scheme</em> is the URI that identifies the rating scheme. It is an optional attribute. If
* this attribute is not included, the default scheme is urn:simple (adult | nonadult).
* </p>
*
* For compatibility, a medai:adult tag will appear in the ratings as a urn:simple equiv.

3
src/main/java/org/rometools/feed/module/mediarss/types/Reference.java
View file

@ -23,7 +23,8 @@
package org.rometools.feed.module.mediarss.types;
/**
* This class is an idenfier for UrlReference and PlayerReference and is required for constructing a MediaContent object.
* This class is an idenfier for UrlReference and PlayerReference and is required for constructing a
* MediaContent object.
*
* @author cooper
*/

33
src/main/java/org/rometools/feed/module/mediarss/types/Restriction.java
View file

@ -31,11 +31,14 @@ import com.sun.syndication.feed.impl.ToStringBean;
* <strong>&lt;media:restriction&gt; </strong></p>
*
* <p>
* Allows restrictions to be placed on the aggregator rendering the media in the feed. Currently, restrictions are based on distributor (uri) and country codes.
* This element is purely informational and no obligation can be assumed or implied. Only one &lt;media:restriction&gt; element of the same <em>type</em> can be
* applied to a media object - all others will be ignored.&nbsp;Entities in this element should be space separated. To allow the producer to explicitly declare
* his/her intentions, two literals are reserved: 'all', 'none'. These literals can only be used once. This element has 1 required attribute, and 1 optional
* attribute (with strict requirements for its exclusion).
* Allows restrictions to be placed on the aggregator rendering the media in the feed. Currently,
* restrictions are based on distributor (uri) and country codes. This element is purely
* informational and no obligation can be assumed or implied. Only one &lt;media:restriction&gt;
* element of the same <em>type</em> can be applied to a media object - all others will be
* ignored.&nbsp;Entities in this element should be space separated. To allow the producer to
* explicitly declare his/her intentions, two literals are reserved: 'all', 'none'. These literals
* can only be used once. This element has 1 required attribute, and 1 optional attribute (with
* strict requirements for its exclusion).
* </p>
*
* <pre>
@ -43,13 +46,14 @@ import com.sun.syndication.feed.impl.ToStringBean;
* </pre>
*
* <p>
* <em>relationship</em> indicates the type of relationship that the restriction represents (allow | deny). In the example above, the media object should only
* be syndicated in Australia and the United States. It is a required attribute.
* <em>relationship</em> indicates the type of relationship that the restriction represents (allow |
* deny). In the example above, the media object should only be syndicated in Australia and the
* United States. It is a required attribute.
* </p>
*
* <p>
* <strong>Note:</strong> If the "allow" element is empty and the type is relationship is "allow", it is assumed that the empty list means "allow nobody" and
* the media should not be syndicated.
* <strong>Note:</strong> If the "allow" element is empty and the type is relationship is "allow",
* it is assumed that the empty list means "allow nobody" and the media should not be syndicated.
* </p>
* <p>
* A more explicit method would be:
@ -60,15 +64,18 @@ import com.sun.syndication.feed.impl.ToStringBean;
* </pre>
*
* <p>
* <em>type</em> specifies the type of restriction (country | uri) that the media can be syndicated. It is an optional attribute; however can only be excluded
* when using one of the literal values "all" or "none".
* <em>type</em> specifies the type of restriction (country | uri) that the media can be syndicated.
* It is an optional attribute; however can only be excluded when using one of the literal values
* "all" or "none".
* </p>
*
* <p>
* "country" allows restrictions to be placed based on country code. [<a href="http://www.iso.org/iso/en/prods-services/iso3166ma/index.html">ISO 3166</a>]
* "country" allows restrictions to be placed based on country code. [<a
* href="http://www.iso.org/iso/en/prods-services/iso3166ma/index.html">ISO 3166</a>]
* </p>
* <p>
* "uri" allows restrictions based on URI. Examples: urn:apple, http://images.google.com, urn:yahoo, etc.
* "uri" allows restrictions based on URI. Examples: urn:apple, http://images.google.com, urn:yahoo,
* etc.
*
* @author cooper
*/

27
src/main/java/org/rometools/feed/module/mediarss/types/Text.java
View file

@ -30,9 +30,11 @@ import com.sun.syndication.feed.impl.ToStringBean;
/**
* <strong>&lt;media:text&gt;</strong></p>
* <p>
* Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content. Many of these elements are permitted to provide a time series
* of text. In such cases, it is encouraged, but not required, that the elements be grouped by language and appear in time sequence order based on the
* <em>start</em> time. Elements can have overlapping <em>start</em> and <em>end</em> times. It has 4 optional attributes.
* Allows the inclusion of a text transcript, closed captioning, or lyrics of the media content.
* Many of these elements are permitted to provide a time series of text. In such cases, it is
* encouraged, but not required, that the elements be grouped by language and appear in time
* sequence order based on the <em>start</em> time. Elements can have overlapping <em>start</em> and
* <em>end</em> times. It has 4 optional attributes.
* </p>
*
* <pre>
@ -43,8 +45,8 @@ import com.sun.syndication.feed.impl.ToStringBean;
* end="00:00:17.000"&gt;By the dawn's early light&lt;/media:text&gt;
* </pre>
* <p>
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'. All html must be entity-encoded.
* It is an optional attribute.
* <em>type</em> specifies the type of text embedded. Possible values are either 'plain' or 'html'.
* Default value is 'plain'. All html must be entity-encoded. It is an optional attribute.
* </p>
*
*
@ -53,18 +55,21 @@ import com.sun.syndication.feed.impl.ToStringBean;
*
*
* <p>
* <em>lang</em> is the primary language encapsulated in the media object. Language codes possible are detailed in RFC 3066. This attribute is used similar to
* the xml:lang attribute detailed in the XML 1.0 Specification (Third Edition). It is an optional attribute.
* <em>lang</em> is the primary language encapsulated in the media object. Language codes possible
* are detailed in RFC 3066. This attribute is used similar to the xml:lang attribute detailed in
* the XML 1.0 Specification (Third Edition). It is an optional attribute.
* </p>
*
* <p>
* <em>start</em> specifies the start time offset that the text starts being relevant to the media object. An example of this would be for closed captioning. It
* uses the NTP time code format (see: the time attribute used in &lt;media:thumbnail&gt;).&nbsp;It is an optional attribute.
* <em>start</em> specifies the start time offset that the text starts being relevant to the media
* object. An example of this would be for closed captioning. It uses the NTP time code format (see:
* the time attribute used in &lt;media:thumbnail&gt;).&nbsp;It is an optional attribute.
* </p>
*
* <p>
* <em>end</em> specifies the end time that the text is relevant. If this attribute is not provided, and a <em>start</em> time is used, it is expected that the
* end time is either the end of the clip or the start of the next &lt;media:text&gt; element.
* <em>end</em> specifies the end time that the text is relevant. If this attribute is not provided,
* and a <em>start</em> time is used, it is expected that the end time is either the end of the clip
* or the start of the next &lt;media:text&gt; element.
* </p>
*
* @author cooper

13
src/main/java/org/rometools/feed/module/mediarss/types/Thumbnail.java
View file

@ -32,8 +32,9 @@ import com.sun.syndication.feed.impl.ToStringBean;
*
*
* <p>
* Allows particular images to be used as representative images for the media object. If multiple thumbnails are included, and time coding is not at play, it is
* assumed that the images are in order of importance. It has 1 required attribute and 3 optional attributes.
* Allows particular images to be used as representative images for the media object. If multiple
* thumbnails are included, and time coding is not at play, it is assumed that the images are in
* order of importance. It has 1 required attribute and 3 optional attributes.
* </p>
*
*
@ -55,9 +56,11 @@ import com.sun.syndication.feed.impl.ToStringBean;
*
*
* <p>
* <em>time</em> specifies the time offset in relation to the media object. Typically this is used when creating multiple keyframes within a single video. The
* format for this attribute should be in the DSM-CC's Normal Play Time (NTP) as used in RTSP [<a href="http://www.ietf.org/rfc/rfc2326.txt">RFC 2326 3.6 Normal
* Play Time</a>]. It is an optional attribute.
* <em>time</em> specifies the time offset in relation to the media object. Typically this is used
* when creating multiple keyframes within a single video. The format for this attribute should be
* in the DSM-CC's Normal Play Time (NTP) as used in RTSP [<a
* href="http://www.ietf.org/rfc/rfc2326.txt">RFC 2326 3.6 Normal Play Time</a>]. It is an optional
* attribute.
* </p>
*/
public class Thumbnail implements Cloneable, Serializable {

6
src/main/java/org/rometools/feed/module/mediarss/types/Time.java
View file

@ -28,7 +28,8 @@ import java.text.NumberFormat;
import com.sun.syndication.feed.impl.EqualsBean;
/**
* Represents a <a href="http://www.ietf.org/rfc/rfc2326.txt">RFC 2326 3.6 Normal Play Time</a> timestamp.
* Represents a <a href="http://www.ietf.org/rfc/rfc2326.txt">RFC 2326 3.6 Normal Play Time</a>
* timestamp.
*
* @author cooper
*/
@ -58,7 +59,8 @@ public class Time implements Serializable {
/**
* Creates a new instance of Time
*
* @param value <a href="http://www.ietf.org/rfc/rfc2326.txt">RFC 2326 3.6 Normal Play Time</a> value
* @param value <a href="http://www.ietf.org/rfc/rfc2326.txt">RFC 2326 3.6 Normal Play Time</a>
* value
*/
public Time(final String value) {
final String[] values = value.split(":");

42
src/main/java/org/rometools/feed/module/opensearch/OpenSearchResponse.java
View file

@ -31,8 +31,8 @@ public interface OpenSearchResponse {
/**
* # totalResults – the maximum number of results available for these search terms
*
* * Restrictions: An integer greater than or equal to 0. * Default: The number of items that were returned in this set of results. * Requirements: May
* appear zero or one time.
* * Restrictions: An integer greater than or equal to 0. * Default: The number of items that
* were returned in this set of results. * Requirements: May appear zero or one time.
*
* @param totalResults A positive integer value.
*/
@ -41,8 +41,8 @@ public interface OpenSearchResponse {
/**
* # totalResults – the maximum number of results available for these search terms
*
* * Restrictions: An integer greater than or equal to 0. * Default: The number of items that were returned in this set of results. * Requirements: May
* appear zero or one time.
* * Restrictions: An integer greater than or equal to 0. * Default: The number of items that
* were returned in this set of results. * Requirements: May appear zero or one time.
*
* @return a positive integer value.
*/
@ -51,7 +51,8 @@ public interface OpenSearchResponse {
/**
* # startIndex – the index of the first item returned in the result.
*
* * Restrictions: An integer greater than or equal to 1. * Note: The first result is 1. * Default: 1 * Requirements: May appear zero or one time.
* * Restrictions: An integer greater than or equal to 1. * Note: The first result is 1. *
* Default: 1 * Requirements: May appear zero or one time.
*
* @param startIndex int value >= 1.
*/
@ -60,7 +61,8 @@ public interface OpenSearchResponse {
/**
* # startIndex – the index of the first item returned in the result.
*
* * Restrictions: An integer greater than or equal to 1. * Note: The first result is 1. * Default: 1 * Requirements: May appear zero or one time.
* * Restrictions: An integer greater than or equal to 1. * Note: The first result is 1. *
* Default: 1 * Requirements: May appear zero or one time.
*
* @return int value >= 1.
*/
@ -69,8 +71,8 @@ public interface OpenSearchResponse {
/**
* # itemsPerPage – the maximum number of items that can appear in one page of results.
*
* * Restrictions: An integer greater than or equal to 1. * Default: The number of items that were returned in this set of results. * Requirements: May
* appear zero or one time.
* * Restrictions: An integer greater than or equal to 1. * Default: The number of items that
* were returned in this set of results. * Requirements: May appear zero or one time.
*
* @param itemsPerPage int value >= 1.
*/
@ -79,8 +81,8 @@ public interface OpenSearchResponse {
/**
* # itemsPerPage – the maximum number of items that can appear in one page of results.
*
* * Restrictions: An integer greater than or equal to 1. * Default: The number of items that were returned in this set of results. * Requirements: May
* appear zero or one time.
* * Restrictions: An integer greater than or equal to 1. * Default: The number of items that
* were returned in this set of results. * Requirements: May appear zero or one time.
*
* @return int value >= 1
*/
@ -89,8 +91,9 @@ public interface OpenSearchResponse {
/**
* # link – a reference back to the OpenSearch Description file
*
* * Attributes: This is a clone of the link element in Atom, including href, hreflang, rel, and type attributes. * Restrictions: The rel attribute must
* equal search. * Note: New in version 1.1. * Requirements: May appear zero or one time.
* * Attributes: This is a clone of the link element in Atom, including href, hreflang, rel, and
* type attributes. * Restrictions: The rel attribute must equal search. * Note: New in version
* 1.1. * Requirements: May appear zero or one time.
*
* @param link link to the open search spec.
*/
@ -99,8 +102,9 @@ public interface OpenSearchResponse {
/**
* # link – a reference back to the OpenSearch Description file
*
* * Attributes: This is a clone of the link element in Atom, including href, hreflang, rel, and type attributes. * Restrictions: The rel attribute must
* equal search. * Note: New in version 1.1. * Requirements: May appear zero or one time.
* * Attributes: This is a clone of the link element in Atom, including href, hreflang, rel, and
* type attributes. * Restrictions: The rel attribute must equal search. * Note: New in version
* 1.1. * Requirements: May appear zero or one time.
*
* @return link to the opensearch spec.
*/
@ -108,8 +112,9 @@ public interface OpenSearchResponse {
// list of OSResponseQuery interfaces
/**
* <code>Query</code> – in an OpenSearch Response, can be used both to echo back the original query and to suggest new searches. Please see the <a
* href="../query/">OpenSearch Query specification</a> for more information.
* <code>Query</code> – in an OpenSearch Response, can be used both to echo back the original
* query and to suggest new searches. Please see the <a href="../query/">OpenSearch Query
* specification</a> for more information.
* <ul>
* <li>Note: <em>New in version 1.1.</em></li>
* <li>Requirements: May appear zero or more times. Note that the “Q” is capitalized.</li>
@ -119,8 +124,9 @@ public interface OpenSearchResponse {
public void setQueries(List<OSQuery> query);
/**
* <code>Query</code> – in an OpenSearch Response, can be used both to echo back the original query and to suggest new searches. Please see the <a
* href="../query/">OpenSearch Query specification</a> for more information.
* <code>Query</code> – in an OpenSearch Response, can be used both to echo back the original
* query and to suggest new searches. Please see the <a href="../query/">OpenSearch Query
* specification</a> for more information.
* <ul>
* <li>Note: <em>New in version 1.1.</em></li>
* <li>Requirements: May appear zero or more times. Note that the “Q” is capitalized.</li>

6
src/main/java/org/rometools/feed/module/opensearch/entity/OSQuery.java
View file

@ -20,7 +20,8 @@ import java.io.Serializable;
import com.sun.syndication.feed.impl.ObjectBean;
/**
* @author Michael W. Nassif (enrouteinc@gmail.com) Class representation of the Query object (Response portion so far)
* @author Michael W. Nassif (enrouteinc@gmail.com) Class representation of the Query object
* (Response portion so far)
*/
public class OSQuery implements Cloneable, Serializable {
private static final long serialVersionUID = 1L;
@ -57,7 +58,8 @@ public class OSQuery implements Cloneable, Serializable {
}
/**
* Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
* Indicates whether some other object is "equal to" this one as defined by the Object equals()
* method.
* <p>
*
* @param other he reference object with which to compare.

4
src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleGenerator.java
View file

@ -54,8 +54,8 @@ public class OpenSearchModuleGenerator implements ModuleGenerator {
/**
* Returns a set with all the URIs (JDOM Namespace elements) this module generator uses.
* <p/>
* It is used by the the feed generators to add their namespace definition in the root element of the generated document (forward-missing of Java 5.0
* Generics).
* It is used by the the feed generators to add their namespace definition in the root element
* of the generated document (forward-missing of Java 5.0 Generics).
* <p/>
*
* @return a set with all the URIs (JDOM Namespace elements) this module generator uses.

3
src/main/java/org/rometools/feed/module/opensearch/impl/OpenSearchModuleParser.java
View file

@ -34,7 +34,8 @@ import com.sun.syndication.feed.module.Module;
import com.sun.syndication.io.ModuleParser;
/**
* @author Michael W. Nassif (enrouteinc@gmail.com) OpenSearch implementation of the ModuleParser class
* @author Michael W. Nassif (enrouteinc@gmail.com) OpenSearch implementation of the ModuleParser
* class
*/
public class OpenSearchModuleParser implements ModuleParser {

3
src/main/java/org/rometools/feed/module/photocast/PhotocastModule.java
View file

@ -47,7 +47,8 @@ import org.rometools.feed.module.photocast.types.Metadata;
import com.sun.syndication.feed.module.Module;
/**
* This is a ROME module that provides support for the "http://www.apple.com/ilife/wallpapers" namespace.
* This is a ROME module that provides support for the "http://www.apple.com/ilife/wallpapers"
* namespace.
*
* See the package information for example usage.
*

3
src/main/java/org/rometools/feed/module/photocast/types/Metadata.java
View file

@ -45,7 +45,8 @@ import com.sun.syndication.feed.impl.EqualsBean;
import com.sun.syndication.feed.impl.ToStringBean;
/**
* This is an immutable class representing the apple-wallpapers:metadata tag in the photocast module.
* This is an immutable class representing the apple-wallpapers:metadata tag in the photocast
* module.
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>
*/

8
src/main/java/org/rometools/feed/module/photocast/types/PhotoDate.java
View file

@ -45,8 +45,9 @@ import java.math.BigDecimal;
import java.util.Date;
/**
* This is a specialized Date class for working with the apple PhotoDate format. It provides a constructor taking a dobule value representing the fractional
* number of days since 00:00:00 01/01/00.
* This is a specialized Date class for working with the apple PhotoDate format. It provides a
* constructor taking a dobule value representing the fractional number of days since 00:00:00
* 01/01/00.
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>
*/
@ -74,7 +75,8 @@ public class PhotoDate extends Date {
}
/**
* Creates a new instance of PhotoDate with the fractional number of days since 00:00:00 01/01/00.
* Creates a new instance of PhotoDate with the fractional number of days since 00:00:00
* 01/01/00.
*
* @param photoDateValue fractional number of days since 00:00:00 01/01/00
*/

34
src/main/java/org/rometools/feed/module/sle/SimpleListExtension.java
View file

@ -23,7 +23,8 @@ import org.rometools.feed.module.sle.types.Sort;
import com.sun.syndication.feed.module.Module;
/**
* This is the primary module interface for the <a href="http://msdn.microsoft.com/xml/rss/sle/">MS Simple List Extensions</a>.
* This is the primary module interface for the <a href="http://msdn.microsoft.com/xml/rss/sle/">MS
* Simple List Extensions</a>.
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>
*/
@ -34,49 +35,54 @@ public interface SimpleListExtension extends Module {
public static final String URI = "http://www.microsoft.com/schemas/rss/core/2005";
/**
* The cf:group element is intended to inform the client that the property to which it refers is one that is “groupable” – that is, that the client should
* provide a user interface that allows the user to group or filter on the values of that property. Groupable properties should contain a small set of
* discrete values (e.g. book genres are perfect for groups).
* The cf:group element is intended to inform the client that the property to which it refers is
* one that is “groupable” – that is, that the client should provide a user interface that
* allows the user to group or filter on the values of that property. Groupable properties
* should contain a small set of discrete values (e.g. book genres are perfect for groups).
*
* @param groupFields Array of types.Group objects.
*/
public void setGroupFields(Group[] groupFields);
/**
* The cf:group element is intended to inform the client that the property to which it refers is one that is “groupable” – that is, that the client should
* provide a user interface that allows the user to group or filter on the values of that property. Groupable properties should contain a small set of
* discrete values (e.g. book genres are perfect for groups).
* The cf:group element is intended to inform the client that the property to which it refers is
* one that is “groupable” – that is, that the client should provide a user interface that
* allows the user to group or filter on the values of that property. Groupable properties
* should contain a small set of discrete values (e.g. book genres are perfect for groups).
*
* @return Array of types.Group objects.
*/
public Group[] getGroupFields();
/**
* The cf:sort element is intended to inform the client that the property to which it refers is one that is “sortable” – that is, that the client should
* provide a user interface that allows the user to sort on that property.
* The cf:sort element is intended to inform the client that the property to which it refers is
* one that is “sortable” – that is, that the client should provide a user interface that allows
* the user to sort on that property.
*
* @param sortFields Array of types.Sort objects
*/
public void setSortFields(Sort[] sortFields);
/**
* The cf:sort element is intended to inform the client that the property to which it refers is one that is “sortable” – that is, that the client should
* provide a user interface that allows the user to sort on that property.
* The cf:sort element is intended to inform the client that the property to which it refers is
* one that is “sortable” – that is, that the client should provide a user interface that allows
* the user to sort on that property.
*
* @return Array of types.Sort objects
*/
public Sort[] getSortFields();
/**
* This XML element allows the publisher of a feed document to indicate to the consumers of the feed that the feed is intended to be consumed as a list.
* (defaults to "list" )
* This XML element allows the publisher of a feed document to indicate to the consumers of the
* feed that the feed is intended to be consumed as a list. (defaults to "list" )
*
* @param value treatAs value
*/
public void setTreatAs(String value);
/**
* This XML element allows the publisher of a feed document to indicate to the consumers of the feed that the feed is intended to be consumed as a list.
* This XML element allows the publisher of a feed document to indicate to the consumers of the
* feed that the feed is intended to be consumed as a list.
*
* @return treatAs value.
*/

10
src/main/java/org/rometools/feed/module/sle/SleEntry.java
View file

@ -25,8 +25,9 @@ import org.rometools.feed.module.sle.types.Sort;
import com.sun.syndication.feed.module.Module;
/**
* This is a <b>parse only</b> module that holds the values of enternal fields declared in the SLE module. These will <b>not</b> be persisted on an output()
* call, <b>nor</b> will changing a value here change a value in another module or a foreign markup tag.
* This is a <b>parse only</b> module that holds the values of enternal fields declared in the SLE
* module. These will <b>not</b> be persisted on an output() call, <b>nor</b> will changing a value
* here change a value in another module or a foreign markup tag.
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>
*/
@ -63,8 +64,9 @@ public interface SleEntry extends Module {
* Returns an array of EntryValues for the fields declared in the heading.
*
* <b>NB:</b><br />
* Right now the parser will take any default=true field and change it to an integer value representing the default order in the field. You should not rely
* on these values data display to a user!
* Right now the parser will take any default=true field and change it to an integer value
* representing the default order in the field. You should not rely on these values data display
* to a user!
*
* @return Array of EntryValue implementations from this entry.
*/

28
src/main/java/org/rometools/feed/module/sle/types/Group.java
View file

@ -24,11 +24,13 @@ import org.jdom2.Namespace;
import com.sun.syndication.feed.impl.ObjectBean;
/**
* The <code>cf:group</code> element is intended to inform the client that the&nbsp;property to which it
* The <code>cf:group</code> element is intended to inform the client that the&nbsp;property to
* which it
*
* refers is one that is “groupable” – that is, that the client should provide a user interface that
*
* allows the user to group or filter on the values of that property. Groupable&nbsp;properties should contain
* allows the user to group or filter on the values of that property. Groupable&nbsp;properties
* should contain
*
* a small set of discrete values (e.g. book genres are perfect for groups). </p>
*
@ -37,16 +39,20 @@ import com.sun.syndication.feed.impl.ObjectBean;
* </p>
*
* <ul>
* <li><b>ns </b>- this attribute is the full namespace used in the property element. If the attribute value is an empty string, it is assumed that
* the&nbsp;property does not live in a namespace. If the ns attribute is omitted, the default value is the empty string. In the example above, the ns attribute
* would contain "http://www.example.com/book". It would <i>not</i> contain the namespace prefix.</li>
* <li><b>element</b> - this attribute is the name of the property (without any namespace). In the example above, the element attribute would contain
* "firstedition" If this attribute is omitted, it is assumed that the label attribute is included and that this <code>cf:group</code> element refers to the
* default sort order.</li>
* <li><b>ns </b>- this attribute is the full namespace used in the property element. If the
* attribute value is an empty string, it is assumed that the&nbsp;property does not live in a
* namespace. If the ns attribute is omitted, the default value is the empty string. In the example
* above, the ns attribute would contain "http://www.example.com/book". It would <i>not</i> contain
* the namespace prefix.</li>
* <li><b>element</b> - this attribute is the name of the property (without any namespace). In the
* example above, the element attribute would contain "firstedition" If this attribute is omitted,
* it is assumed that the label attribute is included and that this <code>cf:group</code> element
* refers to the default sort order.</li>
*
* <li><b>label</b> - this attribute contains a human-readable name for the property to which this <code>cf:group</code> element refers. If it is omitted, the
* client should use the value of the "element" attribute as the human-readable name. The "label" attribute is required if the "element" attribute is
* omitted.&nbsp;&nbsp;</li>
* <li><b>label</b> - this attribute contains a human-readable name for the property to which this
* <code>cf:group</code> element refers. If it is omitted, the client should use the value of the
* "element" attribute as the human-readable name. The "label" attribute is required if the
* "element" attribute is omitted.&nbsp;&nbsp;</li>
* </ul>
*
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>

43
src/main/java/org/rometools/feed/module/sle/types/Sort.java
View file

@ -25,15 +25,18 @@ import com.sun.syndication.feed.impl.ObjectBean;
/**
* <p>
* The <code>cf:sort</code> element is intended to inform the client that the property to which it refers
* The <code>cf:sort</code> element is intended to inform the client that the property to which it
* refers
*
* is one that is “sortable” – that is, that the client should provide a user interface that allows the
* is one that is “sortable” – that is, that the client should provide a user interface that allows
* the
*
* user to sort on that property.
* </p>
*
* <p>
* The <code>cf:sort</code> element can also be used to provide a label for the default sort that appears
* The <code>cf:sort</code> element can also be used to provide a label for the default sort that
* appears
*
* in the list (in this case, only the label attribute should be included).
* </p>
@ -43,20 +46,28 @@ import com.sun.syndication.feed.impl.ObjectBean;
* </p>
*
* <ul>
* <li><b>ns</b> - this attribute is the full namespace used in the property element. If the attribute value is an empty string, it is assumed that
* the&nbsp;property does not live in a namespace. If the ns attribute is omitted, the default value is the empty string. In the example above, the ns attribute
* would contain "http://www.example.com/book". It would <i>not</i> contain the namespace prefix.</li>
* <li><b>element</b> - this attribute is the name of the property (without any namespace). In the example above, the element attribute would contain
* "firstedition" If this attribute is omitted, it is assumed that the label attribute is included and that this <code>cf:sort</code> element refers to the
* default sort order.</li>
* <li><b>ns</b> - this attribute is the full namespace used in the property element. If the
* attribute value is an empty string, it is assumed that the&nbsp;property does not live in a
* namespace. If the ns attribute is omitted, the default value is the empty string. In the example
* above, the ns attribute would contain "http://www.example.com/book". It would <i>not</i> contain
* the namespace prefix.</li>
* <li><b>element</b> - this attribute is the name of the property (without any namespace). In the
* example above, the element attribute would contain "firstedition" If this attribute is omitted,
* it is assumed that the label attribute is included and that this <code>cf:sort</code> element
* refers to the default sort order.</li>
*
* <li><b>label</b> - this attribute contains a human-readable name for the property to which this <code>cf:sort</code> element refers. If it is omitted, the
* client should use the value of the "element" attribute as the human-readable name. The "label" attribute is required if the "element" attribute is omitted.</li>
* <li><b>data-type</b> - this attribute informs the client about the data-type of the property to which this <code>cf:sort</code> element refers.. It contains
* one of the following values: date, number, text. If it is omitted, the default value is text.</li>
* <li><b>default</b> - this attribute indicates whether the property to which this <code>cf:sort</code> element refers is the default sort order in the list.
* The allowed values are "true" and "false". If omitted, the default value is "false". The items in the list <i>must</i> be already be sorted by the element –
* this is, the client should not expect to have to resort by this field if it displaying content directly from the list. The client should respect only the
* <li><b>label</b> - this attribute contains a human-readable name for the property to which this
* <code>cf:sort</code> element refers. If it is omitted, the client should use the value of the
* "element" attribute as the human-readable name. The "label" attribute is required if the
* "element" attribute is omitted.</li>
* <li><b>data-type</b> - this attribute informs the client about the data-type of the property to
* which this <code>cf:sort</code> element refers.. It contains one of the following values: date,
* number, text. If it is omitted, the default value is text.</li>
* <li><b>default</b> - this attribute indicates whether the property to which this
* <code>cf:sort</code> element refers is the default sort order in the list. The allowed values are
* "true" and "false". If omitted, the default value is "false". The items in the list <i>must</i>
* be already be sorted by the element – this is, the client should not expect to have to resort by
* this field if it displaying content directly from the list. The client should respect only the
* first instance of default="true" that it encounters.</li>
*
* </ul>

4
src/main/java/org/rometools/feed/module/sse/SSE091Generator.java
View file

@ -48,8 +48,8 @@ public class SSE091Generator implements DelegatingModuleGenerator {
/**
* Returns a set with all the URIs (JDOM Namespace elements) this module generator uses.
* <p/>
* It is used by the the feed generators to add their namespace definition in the root element of the generated document (forward-missing of Java 5.0
* Generics).
* It is used by the the feed generators to add their namespace definition in the root element
* of the generated document (forward-missing of Java 5.0 Generics).
* <p/>
*
* @return a set with all the URIs (JDOM Namespace elements) this module generator uses.

3
src/main/java/org/rometools/feed/module/sse/modules/SSEModule.java
View file

@ -10,7 +10,8 @@ import com.sun.syndication.feed.CopyFrom;
import com.sun.syndication.feed.module.Module;
/**
* The base module for SSE data synchronization. Defines a namespace, uri, and basic copying operations.
* The base module for SSE data synchronization. Defines a namespace, uri, and basic copying
* operations.
*/
public abstract class SSEModule implements Module {
private static final long serialVersionUID = 1L;

6
src/main/java/org/rometools/feed/module/yahooweather/types/Astronomy.java
View file

@ -46,8 +46,10 @@ import com.sun.syndication.feed.impl.ToStringBean;
/**
* Forecast information about current astronomical conditions. Attributes:
* <ul class="topspace">
* <li>sunrise: today's sunrise time. The time is a string in a local time format of "h:mm am/pm", for example "7:02 am" (string)</li>
* <li>sunset today's sunset time. The time is a string in a local time format of "h:mm am/pm", for example "4:51 pm" (string)</li>
* <li>sunrise: today's sunrise time. The time is a string in a local time format of "h:mm am/pm",
* for example "7:02 am" (string)</li>
* <li>sunset today's sunset time. The time is a string in a local time format of "h:mm am/pm", for
* example "4:51 pm" (string)</li>
* </ul>
*
* @version $Id: Astronomy.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $

13
src/main/java/org/rometools/feed/module/yahooweather/types/Atmosphere.java
View file

@ -46,11 +46,14 @@ import com.sun.syndication.feed.impl.ToStringBean;
* Forecast information about current atmospheric pressure, humidity, and visibility. Attributes:
* <ul class="topspace">
* <li>humidity: humidity, in percent (integer)</li>
* <li>visibility, in the units specified by the distance attribute of the yweather:units element (mi or km). Note that the visibility is specified as the
* actual value * 100. For example, a visibility of 16.5 miles will be specified as 1650. A visibility of 14 kilometers will appear as 1400. (integer) [
* <em>A double here, and adjusted accordingly</em>]</li>
* <li>pressure: barometric pressure, in the units specified by the pressure attribute of the yweather:units element (in or mb). (float).</li>
* <li>rising: state of the barometric pressure: steady (0), rising (1), or falling (2). (integer: 0, 1, 2)</li>
* <li>visibility, in the units specified by the distance attribute of the yweather:units element
* (mi or km). Note that the visibility is specified as the actual value * 100. For example, a
* visibility of 16.5 miles will be specified as 1650. A visibility of 14 kilometers will appear as
* 1400. (integer) [ <em>A double here, and adjusted accordingly</em>]</li>
* <li>pressure: barometric pressure, in the units specified by the pressure attribute of the
* yweather:units element (in or mb). (float).</li>
* <li>rising: state of the barometric pressure: steady (0), rising (1), or falling (2). (integer:
* 0, 1, 2)</li>
* </ul>
*
* @version $Id: Atmosphere.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $

14
src/main/java/org/rometools/feed/module/yahooweather/types/Condition.java
View file

@ -47,11 +47,15 @@ import com.sun.syndication.feed.impl.ToStringBean;
* The current weather conditions. Attributes:
* <ul class="topspace">
* <li>text: a textual description of conditions, for example, "Partly Cloudy" (string)</li>
* <li>code: the condition code for this forecast. You could use this code to choose a text description or image for the forecast. The possible values for this
* element are described in <a href="#codes">Condition Codes</a> (integer)</li>
* <li>temp: the current temperature, in the units specified by the yweather:units element (integer)</li>
* <li>date: the current date and time for which this forecast applies. [<em>I believe this should be the time this condition information was captured</em>] The
* date is in <a href="http://www.rfc-editor.org/rfc/rfc822.txt">RFC822 Section 5</a> format, for example "Wed, 30 Nov 2005 1:56 pm PST" (string)</li>
* <li>code: the condition code for this forecast. You could use this code to choose a text
* description or image for the forecast. The possible values for this element are described in <a
* href="#codes">Condition Codes</a> (integer)</li>
* <li>temp: the current temperature, in the units specified by the yweather:units element (integer)
* </li>
* <li>date: the current date and time for which this forecast applies. [
* <em>I believe this should be the time this condition information was captured</em>] The date is
* in <a href="http://www.rfc-editor.org/rfc/rfc822.txt">RFC822 Section 5</a> format, for example
* "Wed, 30 Nov 2005 1:56 pm PST" (string)</li>
* </ul>
*
* @version $Id: Condition.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $

29
src/main/java/org/rometools/feed/module/yahooweather/types/Forecast.java
View file

@ -44,16 +44,22 @@ import com.sun.syndication.feed.impl.EqualsBean;
import com.sun.syndication.feed.impl.ToStringBean;
/**
* The weather forecast for a specific day. The item element contains multiple forecast elements for today and tomorrow. Attributes:
* The weather forecast for a specific day. The item element contains multiple forecast elements for
* today and tomorrow. Attributes:
* <ul class="topspace">
* <li>day: day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri Sat Sun (string)</li>
* <li>date: the date to which this forecast applies. The date is in "dd Mmm yyyy" format, for example "30 Nov 2005" (string)</li>
* <li>low: the forecasted low temperature for this day, in the units specified by the yweather:units element (integer)</li>
* <li>high: the forecasted high temperature for this day, in the units specified by the yweather:units element (integer)</li>
* <li>day: day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri
* Sat Sun (string)</li>
* <li>date: the date to which this forecast applies. The date is in "dd Mmm yyyy" format, for
* example "30 Nov 2005" (string)</li>
* <li>low: the forecasted low temperature for this day, in the units specified by the
* yweather:units element (integer)</li>
* <li>high: the forecasted high temperature for this day, in the units specified by the
* yweather:units element (integer)</li>
* <li>text: a textual description of conditions, for example, "Partly Cloudy" (string)</li>
*
* <li>code: the condition code for this forecast. You could use this code to choose a text description or image for the forecast. The possible values for this
* element are described in Condition Codes (integer)</li>
* <li>code: the condition code for this forecast. You could use this code to choose a text
* description or image for the forecast. The possible values for this element are described in
* Condition Codes (integer)</li>
* </ul>
*
* @see ConditionCode
@ -84,7 +90,8 @@ public class Forecast implements Serializable, Cloneable {
/**
* Constructs a new Forecast object.
*
* @param day day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri Sat Sun (string)
* @param day day of the week to which this forecast applies. Possible values are Mon Tue Wed
* Thu Fri Sat Sun (string)
* @param date the date to which this forecast applies
* @param low the forecasted low temperature for this day
* @param high the forecasted high temperature for this day
@ -104,7 +111,8 @@ public class Forecast implements Serializable, Cloneable {
/**
* Day of week
*
* @return day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri Sat Sun (string)
* @return day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu
* Fri Sat Sun (string)
*/
public String getDay() {
return day;
@ -113,7 +121,8 @@ public class Forecast implements Serializable, Cloneable {
/**
* Day of week
*
* @param day day of the week to which this forecast applies. Possible values are Mon Tue Wed Thu Fri Sat Sun (string)
* @param day day of the week to which this forecast applies. Possible values are Mon Tue Wed
* Thu Fri Sat Sun (string)
*/
public void setDay(final String day) {
this.day = day;

10
src/main/java/org/rometools/feed/module/yahooweather/types/Units.java
View file

@ -47,13 +47,15 @@ import com.sun.syndication.feed.impl.ToStringBean;
* <ul class="topspace">
* <li>temperature: degree units, f for Fahrenheit or c for Celsius (character)</li>
* <li>distance: units for distance, mi for miles or km for kilometers (string)</li>
* <li>pressure: units of barometric pressure, in for pounds per square inch or mb for millibars (string) [<em>I am pretty sure this is wrong.
* <li>pressure: units of barometric pressure, in for pounds per square inch or mb for millibars
* (string) [<em>I am pretty sure this is wrong.
* I believe this number of be inches of Mercury, not PSI.</em>]</li>
* <li>speed: units of speed, mph for miles per hour or kph for kilometers per hour (string)</li>
* </ul>
* Note that the default RSS feed uses Fahrenheit degree units and English units for all other attributes (miles, pounds per square inch, miles per hour). If
* Celsius has been specified as the degree units for the feed (using the u request parameter), all the units are in metric format (Celsius, kilometers,
* millibars, kilometers per hour).
* Note that the default RSS feed uses Fahrenheit degree units and English units for all other
* attributes (miles, pounds per square inch, miles per hour). If Celsius has been specified as the
* degree units for the feed (using the u request parameter), all the units are in metric format
* (Celsius, kilometers, millibars, kilometers per hour).
*
* @version $Id: Units.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>

10
src/main/java/org/rometools/feed/module/yahooweather/types/Wind.java
View file

@ -47,12 +47,14 @@ import com.sun.syndication.feed.impl.ToStringBean;
* <ul class="topspace">
* <li>temperature: degree units, f for Fahrenheit or c for Celsius (character)</li>
* <li>distance: units for distance, mi for miles or km for kilometers (string)</li>
* <li>pressure: units of barometric pressure, in for pounds per square inch or mb for millibars (string)</li>
* <li>pressure: units of barometric pressure, in for pounds per square inch or mb for millibars
* (string)</li>
* <li>speed: units of speed, mph for miles per hour or kph for kilometers per hour (string)</li>
* </ul>
* Note that the default RSS feed uses Fahrenheit degree units and English units for all other attributes (miles, pounds per square inch, miles per hour). If
* Celsius has been specified as the degree units for the feed (using the u request parameter), all the units are in metric format (Celsius, kilometers,
* millibars, kilometers per hour).
* Note that the default RSS feed uses Fahrenheit degree units and English units for all other
* attributes (miles, pounds per square inch, miles per hour). If Celsius has been specified as the
* degree units for the feed (using the u request parameter), all the units are in metric format
* (Celsius, kilometers, millibars, kilometers per hour).
*
* @version $Id: Wind.java,v 1.2 2008/01/22 14:50:05 kebernet Exp $
* @author <a href="mailto:cooper@screaming-penguin.com">Robert "kebernet" Cooper</a>

8
src/test/java/org/rometools/feed/module/mediarss/MediaModuleTest.java
View file

@ -102,7 +102,7 @@ public class MediaModuleTest extends AbstractTestCase {
final SyndFeed feed = getSyndFeed("org/rometools/feed/module/mediarss/issue-07.xml");
final SyndEntry entry = feed.getEntries().get(0);
final MediaEntryModule module = (MediaEntryModule) entry.getModule(MediaEntryModule.URI);
final MediaEntryModule module = (MediaEntryModule) entry.getModule(MediaModule.URI);
final Thumbnail[] thumbnails = module.getMetadata().getThumbnail();
assertThat(thumbnails, is(notNullValue()));
@ -120,7 +120,7 @@ public class MediaModuleTest extends AbstractTestCase {
final SyndFeed feed = getSyndFeed("org/rometools/feed/module/mediarss/issue-08.xml");
final SyndEntry entry = feed.getEntries().get(0);
final MediaEntryModule module = (MediaEntryModule) entry.getModule(MediaEntryModule.URI);
final MediaEntryModule module = (MediaEntryModule) entry.getModule(MediaModule.URI);
final Thumbnail[] thumbnails = module.getMetadata().getThumbnail();
assertThat(thumbnails, is(notNullValue()));
@ -138,7 +138,7 @@ public class MediaModuleTest extends AbstractTestCase {
final SyndFeed feed = getSyndFeed("org/rometools/feed/module/mediarss/issue-12.xml");
final SyndEntry entry = feed.getEntries().get(0);
final MediaEntryModule module = (MediaEntryModule) entry.getModule(MediaEntryModule.URI);
final MediaEntryModule module = (MediaEntryModule) entry.getModule(MediaModule.URI);
final Rating[] ratings = module.getMetadata().getRatings();
assertThat(ratings, is(notNullValue()));
@ -154,7 +154,7 @@ public class MediaModuleTest extends AbstractTestCase {
public void testParseMediaContentContainingURLWithSpaces() throws Exception {
final SyndFeed feed = getSyndFeed("org/rometools/feed/module/mediarss/issue-20.xml");
final SyndEntry entry = feed.getEntries().get(0);
final MediaEntryModule m = (MediaEntryModule) entry.getModule(MediaEntryModule.URI);
final MediaEntryModule m = (MediaEntryModule) entry.getModule(MediaModule.URI);
assertNotNull("missing media entry module", m);
final MediaContent[] mcs = m.getMediaContents();
assertNotNull("missing media:content", mcs);