From eeeef4b01a94310f0912990a3adc980c711e5ee9 Mon Sep 17 00:00:00 2001 From: kebernet Date: Fri, 25 Feb 2011 03:52:26 +0000 Subject: [PATCH 02/92] Initial checkin unified modules. --- pom.xml | 31 + .../syndication/feed/module/base/Article.java | 396 +++ .../syndication/feed/module/base/Course.java | 567 ++++ .../feed/module/base/CustomTag.java | 125 + .../feed/module/base/CustomTagImpl.java | 215 ++ .../feed/module/base/CustomTags.java | 38 + .../feed/module/base/CustomTagsImpl.java | 66 + .../syndication/feed/module/base/Event.java | 1400 ++++++++ .../feed/module/base/GlobalInterface.java | 532 ++++ .../feed/module/base/GoogleBase.java | 62 + .../feed/module/base/GoogleBaseImpl.java | 1253 ++++++++ .../syndication/feed/module/base/Housing.java | 1563 +++++++++ .../sun/syndication/feed/module/base/Job.java | 860 +++++ .../syndication/feed/module/base/Person.java | 830 +++++ .../syndication/feed/module/base/Product.java | 2833 +++++++++++++++++ .../syndication/feed/module/base/Review.java | 836 +++++ .../feed/module/base/ScholarlyArticle.java | 482 +++ .../syndication/feed/module/base/Service.java | 1286 ++++++++ .../syndication/feed/module/base/Travel.java | 1384 ++++++++ .../syndication/feed/module/base/Unknown.java | 78 + .../feed/module/base/ValidationException.java | 35 + .../syndication/feed/module/base/Vehicle.java | 1895 +++++++++++ .../syndication/feed/module/base/Wanted.java | 306 ++ .../module/base/io/CustomTagGenerator.java | 135 + .../feed/module/base/io/CustomTagParser.java | 122 + .../module/base/io/GoogleBaseGenerator.java | 166 + .../feed/module/base/io/GoogleBaseParser.java | 245 ++ .../syndication/feed/module/base/package.html | 72 + .../feed/module/base/types/CloneableType.java | 50 + .../base/types/CurrencyEnumeration.java | 599 ++++ .../feed/module/base/types/DateTimeRange.java | 127 + .../feed/module/base/types/FloatUnit.java | 159 + .../module/base/types/GenderEnumeration.java | 88 + .../feed/module/base/types/IntUnit.java | 119 + .../base/types/PaymentTypeEnumeration.java | 83 + .../base/types/PriceTypeEnumeration.java | 107 + .../feed/module/base/types/ShippingType.java | 182 ++ .../feed/module/base/types/ShortDate.java | 83 + .../feed/module/base/types/Size.java | 154 + .../feed/module/base/types/YearType.java | 98 + .../feed/module/base/types/package.html | 45 + .../feed/module/cc/CreativeCommons.java | 59 + .../feed/module/cc/CreativeCommonsImpl.java | 124 + .../feed/module/cc/io/CCModuleGenerator.java | 142 + .../feed/module/cc/io/ModuleParserRSS1.java | 133 + .../feed/module/cc/io/ModuleParserRSS2.java | 119 + .../syndication/feed/module/cc/package.html | 80 + .../feed/module/cc/types/License.java | 202 ++ .../feed/module/cc/types/package.html | 45 + .../feed/module/content/ContentItem.java | 203 ++ .../feed/module/content/ContentModule.java | 97 + .../module/content/ContentModuleImpl.java | 108 + .../content/io/ContentModuleGenerator.java | 194 ++ .../content/io/ContentModuleParser.java | 158 + .../feed/module/content/package.html | 66 + .../feed/module/georss/GMLGenerator.java | 163 + .../feed/module/georss/GMLModuleImpl.java | 42 + .../feed/module/georss/GMLParser.java | 155 + .../feed/module/georss/GeoRSSModule.java | 146 + .../feed/module/georss/GeoRSSPoint.java | 62 + .../feed/module/georss/GeoRSSUtils.java | 130 + .../feed/module/georss/SimpleGenerator.java | 133 + .../feed/module/georss/SimpleModuleImpl.java | 42 + .../feed/module/georss/SimpleParser.java | 105 + .../feed/module/georss/W3CGeoGenerator.java | 108 + .../feed/module/georss/W3CGeoModuleImpl.java | 44 + .../feed/module/georss/W3CGeoParser.java | 79 + .../georss/geometries/AbstractCurve.java | 22 + .../AbstractGeometricPrimitive.java | 23 + .../georss/geometries/AbstractGeometry.java | 36 + .../georss/geometries/AbstractRing.java | 27 + .../georss/geometries/AbstractSurface.java | 22 + .../module/georss/geometries/Envelope.java | 96 + .../module/georss/geometries/LineString.java | 65 + .../module/georss/geometries/LinearRing.java | 62 + .../feed/module/georss/geometries/Point.java | 62 + .../module/georss/geometries/Polygon.java | 104 + .../module/georss/geometries/Position.java | 84 + .../georss/geometries/PositionList.java | 144 + .../module/georss/geometries/package.html | 14 + .../feed/module/georss/package.html | 46 + .../module/itunes/AbstractITunesObject.java | 226 ++ .../feed/module/itunes/EntryInformation.java | 67 + .../module/itunes/EntryInformationImpl.java | 119 + .../feed/module/itunes/FeedInformation.java | 106 + .../module/itunes/FeedInformationImpl.java | 197 ++ .../feed/module/itunes/ITunes.java | 132 + .../module/itunes/io/ITunesGenerator.java | 182 ++ .../feed/module/itunes/io/ITunesParser.java | 209 ++ .../itunes/io/ITunesParserOldNamespace.java | 43 + .../feed/module/itunes/package.html | 74 + .../feed/module/itunes/types/Category.java | 123 + .../feed/module/itunes/types/Duration.java | 157 + .../feed/module/itunes/types/Subcategory.java | 99 + .../feed/module/itunes/types/package.html | 47 + .../module/mediarss/MediaEntryModule.java | 45 + .../module/mediarss/MediaEntryModuleImpl.java | 116 + .../feed/module/mediarss/MediaModule.java | 51 + .../feed/module/mediarss/MediaModuleImpl.java | 110 + .../io/AlternateMediaModuleParser.java | 35 + .../mediarss/io/MediaModuleGenerator.java | 261 ++ .../module/mediarss/io/MediaModuleParser.java | 477 +++ .../module/mediarss/io/RSS20YahooParser.java | 94 + .../feed/module/mediarss/io/package.html | 11 + .../feed/module/mediarss/package.html | 54 + .../mediarss/types/AbstractSchemeValue.java | 54 + .../feed/module/mediarss/types/Category.java | 122 + .../feed/module/mediarss/types/Credit.java | 138 + .../module/mediarss/types/Expression.java | 52 + .../feed/module/mediarss/types/Hash.java | 86 + .../module/mediarss/types/MediaContent.java | 458 +++ .../module/mediarss/types/MediaGroup.java | 154 + .../feed/module/mediarss/types/Metadata.java | 620 ++++ .../mediarss/types/PlayerReference.java | 118 + .../feed/module/mediarss/types/Rating.java | 99 + .../feed/module/mediarss/types/Reference.java | 32 + .../module/mediarss/types/Restriction.java | 158 + .../feed/module/mediarss/types/Text.java | 142 + .../feed/module/mediarss/types/Thumbnail.java | 145 + .../feed/module/mediarss/types/Time.java | 106 + .../module/mediarss/types/UrlReference.java | 92 + .../feed/module/mediarss/types/package.html | 10 + .../module/opensearch/OpenSearchModule.java | 27 + .../module/opensearch/OpenSearchResponse.java | 139 + .../RequiredAttributeMissingException.java | 38 + .../module/opensearch/entity/OSQuery.java | 164 + .../impl/OpenSearchModuleGenerator.java | 172 + .../opensearch/impl/OpenSearchModuleImpl.java | 145 + .../impl/OpenSearchModuleParser.java | 240 ++ .../module/photocast/PhotocastModule.java | 122 + .../module/photocast/PhotocastModuleImpl.java | 162 + .../feed/module/photocast/io/Generator.java | 105 + .../feed/module/photocast/io/Parser.java | 135 + .../feed/module/photocast/io/package.html | 10 + .../feed/module/photocast/package.html | 69 + .../feed/module/photocast/types/Metadata.java | 103 + .../module/photocast/types/PhotoDate.java | 104 + .../feed/module/photocast/types/package.html | 10 + .../syndication/feed/module/slash/Slash.java | 70 + .../feed/module/slash/SlashImpl.java | 138 + .../module/slash/io/SlashModuleGenerator.java | 103 + .../module/slash/io/SlashModuleParser.java | 103 + .../feed/module/slash/io/package.html | 45 + .../feed/module/slash/package.html | 68 + .../feed/module/sle/SimpleListExtension.java | 72 + .../module/sle/SimpleListExtensionImpl.java | 103 + .../syndication/feed/module/sle/SleEntry.java | 69 + .../feed/module/sle/SleEntryImpl.java | 144 + .../feed/module/sle/SleUtility.java | 186 ++ .../feed/module/sle/io/ItemParser.java | 153 + .../module/sle/io/LabelNamespaceElement.java | 78 + .../feed/module/sle/io/ModuleGenerator.java | 142 + .../feed/module/sle/io/ModuleParser.java | 176 + .../feed/module/sle/io/package.html | 10 + .../syndication/feed/module/sle/package.html | 53 + .../feed/module/sle/types/DateValue.java | 117 + .../feed/module/sle/types/EntryValue.java | 52 + .../feed/module/sle/types/Group.java | 114 + .../feed/module/sle/types/NumberValue.java | 94 + .../feed/module/sle/types/Sort.java | 163 + .../feed/module/sle/types/StringValue.java | 92 + .../feed/module/sle/types/package.html | 11 + .../feed/module/sse/SSE091Generator.java | 171 + .../feed/module/sse/SSE091Parser.java | 245 ++ .../feed/module/sse/modules/Conflict.java | 89 + .../feed/module/sse/modules/Conflicts.java | 14 + .../feed/module/sse/modules/History.java | 111 + .../feed/module/sse/modules/Related.java | 146 + .../feed/module/sse/modules/SSEModule.java | 53 + .../feed/module/sse/modules/Sharing.java | 137 + .../feed/module/sse/modules/Sync.java | 155 + .../feed/module/sse/modules/Update.java | 61 + .../yahooweather/YWeatherEntryModule.java | 72 + .../yahooweather/YWeatherFeedModule.java | 110 + .../module/yahooweather/YWeatherModule.java | 52 + .../yahooweather/YWeatherModuleImpl.java | 158 + .../io/WeatherModuleGenerator.java | 241 ++ .../yahooweather/io/WeatherModuleParser.java | 213 ++ .../feed/module/yahooweather/io/package.html | 45 + .../feed/module/yahooweather/package.html | 64 + .../module/yahooweather/types/Astronomy.java | 132 + .../module/yahooweather/types/Atmosphere.java | 226 ++ .../module/yahooweather/types/Condition.java | 183 ++ .../yahooweather/types/ConditionCode.java | 425 +++ .../module/yahooweather/types/Forecast.java | 233 ++ .../module/yahooweather/types/Location.java | 146 + .../feed/module/yahooweather/types/Units.java | 177 + .../feed/module/yahooweather/types/Wind.java | 159 + .../module/yahooweather/types/package.html | 43 + .../feed/module/base/io/tags.properties | 91 + src/main/resources/rome.properties | 148 + src/test/java/base/courses-atombase.xml | 69 + src/test/java/base/courses2base.xml | 61 + .../java/base/custom-tags-examplebase.xml | 49 + src/test/java/base/events-atombase.xml | 91 + src/test/java/base/events2base.xml | 80 + src/test/java/base/housing-atombase.xml | 80 + src/test/java/base/housing2base.xml | 76 + src/test/java/base/jobs-atombase.xml | 70 + src/test/java/base/jobs2base.xml | 63 + src/test/java/base/news-atom.xml | 58 + src/test/java/base/news2.xml | 50 + src/test/java/base/personals-atom.xml | 66 + src/test/java/base/personals2.xml | 59 + src/test/java/base/products-atom.xml | 103 + src/test/java/base/products2.xml | 92 + src/test/java/base/research-atom.xml | 59 + src/test/java/base/research2.xml | 52 + src/test/java/base/reviews-atom.xml | 64 + src/test/java/base/reviews2.xml | 56 + src/test/java/base/rss-test-1.xml | 37 + src/test/java/base/services-atom.xml | 72 + src/test/java/base/services2.xml | 63 + src/test/java/base/travel-atom.xml | 91 + src/test/java/base/travel2.xml | 82 + src/test/java/base/vehicles-atom.xml | 95 + src/test/java/base/vehicles2.xml | 87 + src/test/java/base/wanted-atom.xml | 51 + src/test/java/base/wanted2.xml | 41 + .../feed/module/AbstractTestCase.java | 118 + .../feed/module/ITunesGeneratorTest.java | 75 + .../feed/module/MediaModuleTest.java | 145 + .../base/io/CustomTagGeneratorTest.java | 67 + .../module/base/io/CustomTagParserTest.java | 89 + .../base/io/GoogleBaseGeneratorTest.java | 120 + .../module/base/io/GoogleBaseParserTest.java | 572 ++++ .../feed/module/base/types/FloatUnitTest.java | 46 + .../feed/module/base/types/IntUnitTest.java | 46 + .../module/cc/io/CCModuleGeneratorTest.java | 69 + .../feed/module/cc/io/ModuleParserTest.java | 60 + .../feed/module/content/ContentItemTest.java | 142 + .../content/ContentModuleGeneratorTest.java | 47 + .../module/content/ContentModuleImplTest.java | 131 + .../content/ContentModuleParserTest.java | 55 + .../feed/module/content/test-rdf.xml | 51 + .../feed/module/georss/RssTest.java | 223 ++ .../module/itunes/ITunesGeneratorTest.java | 100 + .../feed/module/itunes/ITunesParserTest.java | 91 + .../module/itunes/types/DurationTest.java | 74 + .../feed/module/mediarss/GoogleTest.java | 47 + .../feed/module/mediarss/MediaModuleTest.java | 159 + .../feed/module/mediarss/types/TimeTest.java | 41 + .../opensearch/OpenSearchModuleTest.java | 51 + .../module/photocast/io/GeneratorTest.java | 70 + .../feed/module/sle/GroupAndSortTest.java | 119 + .../module/sle/io/ModuleGeneratorTest.java | 45 + .../feed/module/sle/io/ModuleParserTest.java | 67 + .../feed/module/sse/SSEParserTest.java | 278 ++ .../yahooweather/io/WeahterGeneratorTest.java | 70 + .../io/WeatherModuleParserTest.java | 76 + src/test/java/com/totsp/util/BeanUtility.java | 129 + src/test/java/itunes/leshow.xml | 184 ++ src/test/java/test1media.xml | 3 + src/test/java/test2media.xml | 240 ++ src/test/resources/2.rss | 52 + src/test/resources/data/YahooTopSongs.xml | 534 ++++ src/test/resources/data/bookexample.xml | 32 + src/test/resources/data/rss1.0-w3cgeo.xml | 93 + src/test/resources/data/rss2.0-gml.xml | 55 + src/test/resources/data/rss2.0-simple.xml | 32 + src/test/resources/data/rss2.0-w3cgeo.xml | 51 + src/test/resources/index.rss | 90 + src/test/resources/os/sample1.xml | 114 + src/test/resources/os/sample2.xml | 44 + src/test/resources/test1.xml | 3 + src/test/resources/test2.xml | 240 ++ src/test/resources/test3.xml | 101 + src/test/resources/xml/at.xml | 215 ++ src/test/resources/xml/courses-atom.xml | 69 + src/test/resources/xml/courses2.xml | 61 + .../resources/xml/custom-tags-example.xml | 49 + src/test/resources/xml/ep/ep1_v1a.xml | 107 + src/test/resources/xml/ep/ep1_v1b.xml | 114 + src/test/resources/xml/ep/ep1_v2a.xml | 130 + src/test/resources/xml/ep/ep1_v3a.xml | 133 + src/test/resources/xml/ep/ep1_v4a.xml | 149 + src/test/resources/xml/ep/ep1_v5a.xml | 138 + src/test/resources/xml/ep/ep2_v1a.xml | 107 + src/test/resources/xml/ep/ep2_v1b.xml | 114 + src/test/resources/xml/ep/ep2_v2a.xml | 130 + src/test/resources/xml/ep/ep2_v3a.xml | 133 + src/test/resources/xml/ep/ep2_v4a.xml | 149 + src/test/resources/xml/ep/ep2_v5a.xml | 138 + src/test/resources/xml/events-atom.xml | 91 + src/test/resources/xml/events2.xml | 80 + src/test/resources/xml/housing-atom.xml | 80 + src/test/resources/xml/housing2.xml | 76 + src/test/resources/xml/jobs-atom.xml | 70 + src/test/resources/xml/jobs2.xml | 63 + src/test/resources/xml/leshow.xml | 184 ++ src/test/resources/xml/leshow.xml.output | 87 + src/test/resources/xml/lr.xml | 261 ++ src/test/resources/xml/lr.xml.output | 258 ++ src/test/resources/xml/news-atom.xml | 58 + src/test/resources/xml/news2.xml | 50 + src/test/resources/xml/personals-atom.xml | 66 + src/test/resources/xml/personals2.xml | 59 + src/test/resources/xml/products-atom.xml | 103 + src/test/resources/xml/products2.xml | 92 + src/test/resources/xml/research-atom.xml | 59 + src/test/resources/xml/research2.xml | 52 + src/test/resources/xml/reviews-atom.xml | 64 + src/test/resources/xml/reviews2.xml | 56 + src/test/resources/xml/rsr.xml | 251 ++ src/test/resources/xml/rss-playlist-sse.xml | 116 + src/test/resources/xml/rss-playlist.xml | 75 + src/test/resources/xml/rss-test-1.xml | 37 + src/test/resources/xml/rss1sample.xml | 62 + .../xml/rssCreativeCommonsExample.xml | 27 + src/test/resources/xml/services-atom.xml | 72 + src/test/resources/xml/services2.xml | 63 + .../resources/xml/simple/rss-playlist-sse.xml | 102 + .../resources/xml/simple/rss-playlist.xml | 62 + src/test/resources/xml/slashdot.xml | 178 ++ src/test/resources/xml/sunnyvale.xml | 49 + src/test/resources/xml/test-rdf.xml | 51 + src/test/resources/xml/totsp.xml | 32 + src/test/resources/xml/travel-atom.xml | 91 + src/test/resources/xml/travel2.xml | 82 + src/test/resources/xml/v/v1.xml | 100 + src/test/resources/xml/v/v2.xml | 128 + src/test/resources/xml/v/v3.xml | 132 + src/test/resources/xml/v/v4.xml | 147 + src/test/resources/xml/v/v5.xml | 151 + src/test/resources/xml/v/v6.xml | 153 + src/test/resources/xml/vehicles-atom.xml | 95 + src/test/resources/xml/vehicles2.xml | 87 + src/test/resources/xml/wanted-atom.xml | 51 + src/test/resources/xml/wanted2.xml | 41 + 329 files changed, 50813 insertions(+) create mode 100644 pom.xml create mode 100644 src/main/java/com/sun/syndication/feed/module/base/Article.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/Course.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/CustomTag.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/CustomTagImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/CustomTags.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/CustomTagsImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/Event.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/GlobalInterface.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/GoogleBase.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/GoogleBaseImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/Housing.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/Job.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/Person.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/Product.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/Review.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/ScholarlyArticle.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/Service.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/Travel.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/Unknown.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/ValidationException.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/Vehicle.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/Wanted.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/io/CustomTagGenerator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/io/CustomTagParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/io/GoogleBaseGenerator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/io/GoogleBaseParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/base/types/CloneableType.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/types/CurrencyEnumeration.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/types/DateTimeRange.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/types/FloatUnit.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/types/GenderEnumeration.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/types/IntUnit.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/types/PaymentTypeEnumeration.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/types/PriceTypeEnumeration.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/types/ShippingType.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/types/ShortDate.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/types/Size.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/types/YearType.java create mode 100644 src/main/java/com/sun/syndication/feed/module/base/types/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/cc/CreativeCommons.java create mode 100644 src/main/java/com/sun/syndication/feed/module/cc/CreativeCommonsImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/cc/io/CCModuleGenerator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/cc/io/ModuleParserRSS1.java create mode 100644 src/main/java/com/sun/syndication/feed/module/cc/io/ModuleParserRSS2.java create mode 100644 src/main/java/com/sun/syndication/feed/module/cc/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/cc/types/License.java create mode 100644 src/main/java/com/sun/syndication/feed/module/cc/types/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/content/ContentItem.java create mode 100644 src/main/java/com/sun/syndication/feed/module/content/ContentModule.java create mode 100644 src/main/java/com/sun/syndication/feed/module/content/ContentModuleImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/content/io/ContentModuleGenerator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/content/io/ContentModuleParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/content/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/GMLGenerator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/GMLModuleImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/GMLParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/GeoRSSModule.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/GeoRSSPoint.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/GeoRSSUtils.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/SimpleGenerator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/SimpleModuleImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/SimpleParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/W3CGeoGenerator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/W3CGeoModuleImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/W3CGeoParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/geometries/AbstractCurve.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/geometries/AbstractGeometricPrimitive.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/geometries/AbstractGeometry.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/geometries/AbstractRing.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/geometries/AbstractSurface.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/geometries/Envelope.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/geometries/LineString.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/geometries/LinearRing.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/geometries/Point.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/geometries/Polygon.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/geometries/Position.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/geometries/PositionList.java create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/geometries/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/georss/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/AbstractITunesObject.java create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/EntryInformation.java create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/EntryInformationImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/FeedInformation.java create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/FeedInformationImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/ITunes.java create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/io/ITunesGenerator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/io/ITunesParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/io/ITunesParserOldNamespace.java create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/types/Category.java create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/types/Duration.java create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/types/Subcategory.java create mode 100644 src/main/java/com/sun/syndication/feed/module/itunes/types/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/MediaEntryModule.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/MediaEntryModuleImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/MediaModule.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/MediaModuleImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/io/AlternateMediaModuleParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/io/MediaModuleGenerator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/io/MediaModuleParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/io/RSS20YahooParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/io/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/AbstractSchemeValue.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/Category.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/Credit.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/Expression.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/Hash.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/MediaContent.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/MediaGroup.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/Metadata.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/PlayerReference.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/Rating.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/Reference.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/Restriction.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/Text.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/Thumbnail.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/Time.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/UrlReference.java create mode 100644 src/main/java/com/sun/syndication/feed/module/mediarss/types/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/opensearch/OpenSearchModule.java create mode 100644 src/main/java/com/sun/syndication/feed/module/opensearch/OpenSearchResponse.java create mode 100644 src/main/java/com/sun/syndication/feed/module/opensearch/RequiredAttributeMissingException.java create mode 100644 src/main/java/com/sun/syndication/feed/module/opensearch/entity/OSQuery.java create mode 100644 src/main/java/com/sun/syndication/feed/module/opensearch/impl/OpenSearchModuleGenerator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/opensearch/impl/OpenSearchModuleImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/opensearch/impl/OpenSearchModuleParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/photocast/PhotocastModule.java create mode 100644 src/main/java/com/sun/syndication/feed/module/photocast/PhotocastModuleImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/photocast/io/Generator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/photocast/io/Parser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/photocast/io/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/photocast/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/photocast/types/Metadata.java create mode 100644 src/main/java/com/sun/syndication/feed/module/photocast/types/PhotoDate.java create mode 100644 src/main/java/com/sun/syndication/feed/module/photocast/types/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/slash/Slash.java create mode 100644 src/main/java/com/sun/syndication/feed/module/slash/SlashImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/slash/io/SlashModuleGenerator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/slash/io/SlashModuleParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/slash/io/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/slash/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/SimpleListExtension.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/SimpleListExtensionImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/SleEntry.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/SleEntryImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/SleUtility.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/io/ItemParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/io/LabelNamespaceElement.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/io/ModuleGenerator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/io/ModuleParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/io/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/types/DateValue.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/types/EntryValue.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/types/Group.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/types/NumberValue.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/types/Sort.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/types/StringValue.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sle/types/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/sse/SSE091Generator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sse/SSE091Parser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sse/modules/Conflict.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sse/modules/Conflicts.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sse/modules/History.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sse/modules/Related.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sse/modules/SSEModule.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sse/modules/Sharing.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sse/modules/Sync.java create mode 100644 src/main/java/com/sun/syndication/feed/module/sse/modules/Update.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/YWeatherEntryModule.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/YWeatherFeedModule.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/YWeatherModule.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/YWeatherModuleImpl.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/io/WeatherModuleGenerator.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/io/WeatherModuleParser.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/io/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/package.html create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/types/Astronomy.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/types/Atmosphere.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/types/Condition.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/types/ConditionCode.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/types/Forecast.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/types/Location.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/types/Units.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/types/Wind.java create mode 100644 src/main/java/com/sun/syndication/feed/module/yahooweather/types/package.html create mode 100644 src/main/resources/com/sun/syndication/feed/module/base/io/tags.properties create mode 100644 src/main/resources/rome.properties create mode 100644 src/test/java/base/courses-atombase.xml create mode 100644 src/test/java/base/courses2base.xml create mode 100644 src/test/java/base/custom-tags-examplebase.xml create mode 100644 src/test/java/base/events-atombase.xml create mode 100644 src/test/java/base/events2base.xml create mode 100644 src/test/java/base/housing-atombase.xml create mode 100644 src/test/java/base/housing2base.xml create mode 100644 src/test/java/base/jobs-atombase.xml create mode 100644 src/test/java/base/jobs2base.xml create mode 100644 src/test/java/base/news-atom.xml create mode 100644 src/test/java/base/news2.xml create mode 100644 src/test/java/base/personals-atom.xml create mode 100644 src/test/java/base/personals2.xml create mode 100644 src/test/java/base/products-atom.xml create mode 100644 src/test/java/base/products2.xml create mode 100644 src/test/java/base/research-atom.xml create mode 100644 src/test/java/base/research2.xml create mode 100644 src/test/java/base/reviews-atom.xml create mode 100644 src/test/java/base/reviews2.xml create mode 100644 src/test/java/base/rss-test-1.xml create mode 100644 src/test/java/base/services-atom.xml create mode 100644 src/test/java/base/services2.xml create mode 100644 src/test/java/base/travel-atom.xml create mode 100644 src/test/java/base/travel2.xml create mode 100644 src/test/java/base/vehicles-atom.xml create mode 100644 src/test/java/base/vehicles2.xml create mode 100644 src/test/java/base/wanted-atom.xml create mode 100644 src/test/java/base/wanted2.xml create mode 100644 src/test/java/com/sun/syndication/feed/module/AbstractTestCase.java create mode 100644 src/test/java/com/sun/syndication/feed/module/ITunesGeneratorTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/MediaModuleTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/base/io/CustomTagGeneratorTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/base/io/CustomTagParserTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/base/io/GoogleBaseGeneratorTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/base/io/GoogleBaseParserTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/base/types/FloatUnitTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/base/types/IntUnitTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/cc/io/CCModuleGeneratorTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/cc/io/ModuleParserTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/content/ContentItemTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/content/ContentModuleGeneratorTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/content/ContentModuleImplTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/content/ContentModuleParserTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/content/test-rdf.xml create mode 100644 src/test/java/com/sun/syndication/feed/module/georss/RssTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/itunes/ITunesGeneratorTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/itunes/ITunesParserTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/itunes/types/DurationTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/mediarss/GoogleTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/mediarss/MediaModuleTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/mediarss/types/TimeTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/opensearch/OpenSearchModuleTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/photocast/io/GeneratorTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/sle/GroupAndSortTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/sle/io/ModuleGeneratorTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/sle/io/ModuleParserTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/sse/SSEParserTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/yahooweather/io/WeahterGeneratorTest.java create mode 100644 src/test/java/com/sun/syndication/feed/module/yahooweather/io/WeatherModuleParserTest.java create mode 100644 src/test/java/com/totsp/util/BeanUtility.java create mode 100644 src/test/java/itunes/leshow.xml create mode 100644 src/test/java/test1media.xml create mode 100644 src/test/java/test2media.xml create mode 100644 src/test/resources/2.rss create mode 100644 src/test/resources/data/YahooTopSongs.xml create mode 100644 src/test/resources/data/bookexample.xml create mode 100644 src/test/resources/data/rss1.0-w3cgeo.xml create mode 100644 src/test/resources/data/rss2.0-gml.xml create mode 100644 src/test/resources/data/rss2.0-simple.xml create mode 100644 src/test/resources/data/rss2.0-w3cgeo.xml create mode 100644 src/test/resources/index.rss create mode 100644 src/test/resources/os/sample1.xml create mode 100644 src/test/resources/os/sample2.xml create mode 100644 src/test/resources/test1.xml create mode 100644 src/test/resources/test2.xml create mode 100644 src/test/resources/test3.xml create mode 100644 src/test/resources/xml/at.xml create mode 100644 src/test/resources/xml/courses-atom.xml create mode 100644 src/test/resources/xml/courses2.xml create mode 100644 src/test/resources/xml/custom-tags-example.xml create mode 100644 src/test/resources/xml/ep/ep1_v1a.xml create mode 100644 src/test/resources/xml/ep/ep1_v1b.xml create mode 100644 src/test/resources/xml/ep/ep1_v2a.xml create mode 100644 src/test/resources/xml/ep/ep1_v3a.xml create mode 100644 src/test/resources/xml/ep/ep1_v4a.xml create mode 100644 src/test/resources/xml/ep/ep1_v5a.xml create mode 100644 src/test/resources/xml/ep/ep2_v1a.xml create mode 100644 src/test/resources/xml/ep/ep2_v1b.xml create mode 100644 src/test/resources/xml/ep/ep2_v2a.xml create mode 100644 src/test/resources/xml/ep/ep2_v3a.xml create mode 100644 src/test/resources/xml/ep/ep2_v4a.xml create mode 100644 src/test/resources/xml/ep/ep2_v5a.xml create mode 100644 src/test/resources/xml/events-atom.xml create mode 100644 src/test/resources/xml/events2.xml create mode 100644 src/test/resources/xml/housing-atom.xml create mode 100644 src/test/resources/xml/housing2.xml create mode 100644 src/test/resources/xml/jobs-atom.xml create mode 100644 src/test/resources/xml/jobs2.xml create mode 100644 src/test/resources/xml/leshow.xml create mode 100644 src/test/resources/xml/leshow.xml.output create mode 100644 src/test/resources/xml/lr.xml create mode 100644 src/test/resources/xml/lr.xml.output create mode 100644 src/test/resources/xml/news-atom.xml create mode 100644 src/test/resources/xml/news2.xml create mode 100644 src/test/resources/xml/personals-atom.xml create mode 100644 src/test/resources/xml/personals2.xml create mode 100644 src/test/resources/xml/products-atom.xml create mode 100644 src/test/resources/xml/products2.xml create mode 100644 src/test/resources/xml/research-atom.xml create mode 100644 src/test/resources/xml/research2.xml create mode 100644 src/test/resources/xml/reviews-atom.xml create mode 100644 src/test/resources/xml/reviews2.xml create mode 100644 src/test/resources/xml/rsr.xml create mode 100644 src/test/resources/xml/rss-playlist-sse.xml create mode 100644 src/test/resources/xml/rss-playlist.xml create mode 100644 src/test/resources/xml/rss-test-1.xml create mode 100644 src/test/resources/xml/rss1sample.xml create mode 100644 src/test/resources/xml/rssCreativeCommonsExample.xml create mode 100644 src/test/resources/xml/services-atom.xml create mode 100644 src/test/resources/xml/services2.xml create mode 100644 src/test/resources/xml/simple/rss-playlist-sse.xml create mode 100644 src/test/resources/xml/simple/rss-playlist.xml create mode 100644 src/test/resources/xml/slashdot.xml create mode 100644 src/test/resources/xml/sunnyvale.xml create mode 100644 src/test/resources/xml/test-rdf.xml create mode 100644 src/test/resources/xml/totsp.xml create mode 100644 src/test/resources/xml/travel-atom.xml create mode 100644 src/test/resources/xml/travel2.xml create mode 100644 src/test/resources/xml/v/v1.xml create mode 100644 src/test/resources/xml/v/v2.xml create mode 100644 src/test/resources/xml/v/v3.xml create mode 100644 src/test/resources/xml/v/v4.xml create mode 100644 src/test/resources/xml/v/v5.xml create mode 100644 src/test/resources/xml/v/v6.xml create mode 100644 src/test/resources/xml/vehicles-atom.xml create mode 100644 src/test/resources/xml/vehicles2.xml create mode 100644 src/test/resources/xml/wanted-atom.xml create mode 100644 src/test/resources/xml/wanted2.xml diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..869b337 --- /dev/null +++ b/pom.xml @@ -0,0 +1,31 @@ + + + 4.0.0 + com.sun.syndication + rome-modules + jar + 1.0-SNAPSHOT + rome-modules + http://rome.java.net + + + maven2-repository.dev.java.net + http://download.java.net/maven/2 + + + + + junit + junit + 3.8.1 + test + + + rome + rome + 1.0 + compile + + + diff --git a/src/main/java/com/sun/syndication/feed/module/base/Article.java b/src/main/java/com/sun/syndication/feed/module/base/Article.java new file mode 100644 index 0000000..83c4d60 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/Article.java @@ -0,0 +1,396 @@ +/* + * Article.java + * + * Created on November 16, 2005, 1:01 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.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. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.2 $ + */ +public interface Article extends GlobalInterface { + /** + * Array of Author Names. Limit 10. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * author
+ * Details + * Author of the item.
+ * Example <g:author>John Steinbeck</g:author>
+ * Attribute of + * Reference Items, News and Articles
+ * Content type + * string
+ * @param authors Array of Author Names. Limit 10. + */ + public void setAuthors(String[] authors); + + /** + * Array of Author Names. Limit 10. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * author
+ * Details + * Author of the item.
+ * Example <g:author>John Steinbeck</g:author>
+ * Attribute of + * Reference Items, News and Articles
+ * Content type + * string
+ * @return Array of author names. + */ + public String[] getAuthors(); + + /** + * Source for this article. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * news_source
+ * Details + * The source of news content.
+ * Example <g:news_source>Journal</g:news_source>
+ * Attribute of + * News and Articles
+ * + * Content type + * string
+ * @param newsSource Source for this article + */ + public void setNewsSource(String newsSource); + + /** + * Source for this article. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * news_source
+ * Details + * The source of news content.
+ * Example <g:news_source>Journal</g:news_source>
+ * Attribute of + * News and Articles
+ * + * Content type + * string
+ * @return source for this article. + */ + public String getNewsSource(); + + /** + * Number of pages in the article. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * pages
+ * Details + * + * The number of pages in the publication.
+ * Example <g:pages>18</g:pages>
+ * Attribute of + * Reference Items, News and Articles
+ * + * Content type + * integer
+ * @param pages Number of pages in the article + */ + public void setPages(Integer pages); + + /** + * Number of pages in the article. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * pages
+ * Details + * + * The number of pages in the publication.
+ * Example <g:pages>18</g:pages>
+ * Attribute of + * Reference Items, News and Articles
+ * + * Content type + * integer
+ * @return Number of pages in the article + */ + public Integer getPages(); + + /** + * Date article was published. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * publish_date
+ * + * Details + * Date the item was published in ISO 8601 format: + * YYYY-MM-DD
+ * + * Example <g:publish_date>2005-12-20</g:publish_date>
+ * Attribute of + * Reference Items
+ * + * Content type + * + * date
+ * @param publishDate Date article was published + */ + public void setPublishDate(Date publishDate); + + /** + * Date article was published. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * publish_date
+ * + * Details + * Date the item was published in ISO 8601 format: + * YYYY-MM-DD
+ * + * Example <g:publish_date>2005-12-20</g:publish_date>
+ * Attribute of + * Reference Items
+ * + * Content type + * + * date
+ * @return Date article was published + */ + public Date getPublishDate(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/Course.java b/src/main/java/com/sun/syndication/feed/module/base/Course.java new file mode 100644 index 0000000..33177f3 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/Course.java @@ -0,0 +1,567 @@ +/* + * CourseInformation.java + * + * Created on November 16, 2005, 11:12 AM + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.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. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.2 $ + */ +public interface Course extends GlobalInterface { + /** + * The timeframe a course is running. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * course_date_range
+ * DetailsDate and time range a class is in session, in ISO 8601. Two sub-attributes + * are included in course_date_range attribute.
    + * + *
  • start = Start date and time of a trip in + * format YYYY-MM-DDThh:mm:ss
    • + *
  • end = End date and time of a trip in + * format YYYY-MM-DDThh:mm:ss
+ * Example <g:course_date_range>
+ * + * <g:start>2005-12-20T09:30:01</g:start> + *
+ * <g:end>2005-12-29T10:30:59</g:end>
+ * </g:course_date_range>
+ * + * Attribute of + * Course schedules
+ * + * Content type + * dateTimeRange
+ * @param courseDateRange The timeframe a course is running + */ + public void setCourseDateRange(DateTimeRange courseDateRange); + + /** + * The timeframe a course is running. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * course_date_range
+ * DetailsDate and time range a class is in session, in ISO 8601. Two sub-attributes + * are included in course_date_range attribute.
    + * + *
  • start = Start date and time of a trip in + * format YYYY-MM-DDThh:mm:ss
    • + *
  • end = End date and time of a trip in + * format YYYY-MM-DDThh:mm:ss
+ * Example <g:course_date_range>
+ * + * <g:start>2005-12-20T09:30:01</g:start> + *
+ * <g:end>2005-12-29T10:30:59</g:end>
+ * </g:course_date_range>
+ * + * Attribute of + * Course schedules
+ * + * Content type + * dateTimeRange
+ * @return The timeframe a course is running + */ + public DateTimeRange getCourseDateRange(); + + /** + * ID code associated with a course. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
course_number
Details ID code associated with a course
Example <g:course_number>HIST-90A</g:course_number>
Attribute + * of Course schedules
Content + * type string
+ * @param courseNumber ID code associated with a course + */ + public void setCourseNumber(String courseNumber); + + /** + * ID code associated with a course. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
course_number
Details ID code associated with a course
Example <g:course_number>HIST-90A</g:course_number>
Attribute + * of Course schedules
Content + * type string
+ * @return ID code associated with a course + */ + public String getCourseNumber(); + + /** + * Time a class is in session. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
course_times
Details Time a class is in session.
Example <g:course_times>MWF 08:30 - 09:45</g:course_times>
Attribute + * of Course schedules
Content + * type string
+ * @param courseTimes Time a class is in session + */ + public void setCourseTimes(String courseTimes); + + /** + * Time a class is in session. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
course_times
Details Time a class is in session.
Example <g:course_times>MWF 08:30 - 09:45</g:course_times>
Attribute + * of Course schedules
Content + * type string
+ * @return Time a class is in session + */ + public String getCourseTimes(); + + /** + * Salary for this position. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * salary
+ * Details + * Salary for this position. Non-numeric values such as "$" symbols are not acceptable.
+ * + * Example + * <g:salary>55000</g:salary>
+ * + * Attribute of + * Jobs
+ * Content type + * + * float
+ * @param salary Salary for this position + */ + public void setSalary(Float salary); + + /** + * Salary for this position. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * salary
+ * Details + * Salary for this position. Non-numeric values such as "$" symbols are not acceptable.
+ * + * Example + * <g:salary>55000</g:salary>
+ * + * Attribute of + * Jobs
+ * Content type + * + * float
+ * @return Salary for this position + */ + public Float getSalary(); + + /** + * Topics of study for a course. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * subject
+ * + * Details + * Topic of study for a course.
+ * Example <g:subject>Trigonometry</g:subject>
+ * Attribute of + * + * Course schedules
+ * Content type + * string
+ * @param subject Topics of study for a course + */ + public void setSubjects(String[] subject); + + /** + * Topics of study for a course. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * subject
+ * + * Details + * Topic of study for a course.
+ * Example <g:subject>Trigonometry</g:subject>
+ * Attribute of + * + * Course schedules
+ * Content type + * string
+ * @return Topics of study for a course + */ + public String[] getSubjects(); + + /** + * Name of the school at which a class is offered. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * university
+ * Details + * Name of the school a class is offered at.
+ * Example <g:university>Stanford</g:university>
+ * + * Attribute of + * Course schedules
+ * Content type + * + * string
+ * @param university Name of the school at which a class is offered. + */ + public void setUniversity(String university); + + /** + * Name of the school at which a class is offered. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * university
+ * Details + * Name of the school a class is offered at.
+ * Example <g:university>Stanford</g:university>
+ * + * Attribute of + * Course schedules
+ * Content type + * + * string
+ * @return Name of the school at which a class is offered. + */ + public String getUniversity(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/CustomTag.java b/src/main/java/com/sun/syndication/feed/module/base/CustomTag.java new file mode 100644 index 0000000..6e23f39 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/CustomTag.java @@ -0,0 +1,125 @@ +/* + * CustomTag.java + * + * Created on February 6, 2006, 12:17 AM + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +package com.sun.syndication.feed.module.base; + + +/** + * This class represents a custom tag name and value. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.2 $ + */ +public interface CustomTag { + + /** + * Returns the tag name used. + * @return Returns the tag name used. + */ + public String getName(); + + /** + * The value of the custom tag. + *
+ *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
Type (JavaType)DescriptionExamples
string (String)Any stringBlue
int (Integer)Whole number values1000
float (Float)Numbers with decimal digits3.5
intUnit (IntUnit)Whole number value and a string10 km
floatUnit (FloatUnit)Numbers with decimal digits and a string1.5 km
date (ShortDate)Date of an event, in format YYYY-MM-DD2005-12-12
dateTime (java.util.Date)Date and time for an event, in format YYYY-MM-DDThh:mm:ss2005-12-12T12:00:00
dateTimeRange (DateTimeRange)Start and end dates for an event. An attribute of this type will contain two sub-attributes, <start> and <end> in format YYYY-MM-DD<start>1975-09-25</start>
<end>1975-09-25</end> + * + *
url (java.net.URL)HTTP URL http://www.google.com
boolean (Boolean)Value may be either true or false.true
location (CustomTagImpl.Location)Location921 W. Dana Street, Mtn View, CA-94103
+ * @return The value of the tag. The objects class is determined by the "type" attribute on the tag. + */ + public Object getValue(); + +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/CustomTagImpl.java b/src/main/java/com/sun/syndication/feed/module/base/CustomTagImpl.java new file mode 100644 index 0000000..bc38f4d --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/CustomTagImpl.java @@ -0,0 +1,215 @@ +/* + * CustomTagImpl.java + * + * Created on February 6, 2006, 12:06 AM + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.feed.module.base.types.DateTimeRange; +import com.sun.syndication.feed.module.base.types.FloatUnit; +import com.sun.syndication.feed.module.base.types.IntUnit; +import com.sun.syndication.feed.module.base.types.ShortDate; + +import java.net.URL; + +import java.util.Date; + + +/** + * @version $Revision: 1.1 $ + * @author Robert "kebernet" Cooper + */ +public class CustomTagImpl implements CustomTag { + private Object value; + private String name; + + /** Creates a new instance of CustomTagImpl */ + public CustomTagImpl(String name,String value) { + if( name == null || value == null ){ throw new NullPointerException("Name and Value cannont be null."); } + this.name = name; + this.value = value; + } + + public CustomTagImpl(String name,Integer value) { + if( name == null || value == null ){ throw new NullPointerException("Name and Value cannont be null."); } + this.name = name; + this.value = value; + } + + public CustomTagImpl(String name,Float value) { + if( name == null || value == null ){ throw new NullPointerException("Name and Value cannont be null."); } + this.name = name; + this.value = value; + } + + public CustomTagImpl(String name,IntUnit value) { + if( name == null || value == null ){ throw new NullPointerException("Name and Value cannont be null."); } + this.name = name; + this.value = value; + } + + public CustomTagImpl(String name,FloatUnit value) { + if( name == null || value == null ){ throw new NullPointerException("Name and Value cannont be null."); } + this.name = name; + this.value = value; + } + + public CustomTagImpl(String name,ShortDate value) { + if( name == null || value == null ){ throw new NullPointerException("Name and Value cannont be null."); } + this.name = name; + this.value = value; + } + + public CustomTagImpl(String name,Date value) { + if( name == null || value == null ){ throw new NullPointerException("Name and Value cannont be null."); } + this.name = name; + this.value = value; + } + + public CustomTagImpl(String name,DateTimeRange value) { + if( name == null || value == null ){ throw new NullPointerException("Name and Value cannont be null."); } + this.name = name; + this.value = value; + } + + public CustomTagImpl(String name,URL value) { + if( name == null || value == null ){ throw new NullPointerException("Name and Value cannont be null."); } + this.name = name; + this.value = value; + } + + public CustomTagImpl(String name,Boolean value) { + if( name == null || value == null ){ throw new NullPointerException("Name and Value cannont be null."); } + this.name = name; + this.value = value; + } + + public CustomTagImpl(String name,Location value) { + if( name == null || value == null ){ throw new NullPointerException("Name and Value cannont be null."); } + this.name = name; + this.value = value; + } + + public String getName() { + return this.name; + } + + public Object getValue() { + return this.value; + } + + public boolean equals( Object o ){ + if( o instanceof CustomTag ){ + CustomTag tag = (CustomTag) o; + if( this.name.equals( tag.getName() ) && this.value.equals( tag.getValue() )) + return true; + } + return false; + } + + /** + * 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 x, the expression: + *
+ * 
+     * x.clone() != x
+ * will be true, and that the expression: + *
+ * 
+     * x.clone().getClass() == x.getClass()
+ * will be true, but these are not absolute requirements. + * While it is typically the case that: + *
+ * 
+     * x.clone().equals(x)
+ * will be true, this is not an absolute requirement. + *

+ * By convention, the returned object should be obtained by calling + * super.clone. If a class and all of its superclasses (except + * Object) obey this convention, it will be the case that + * x.clone().getClass() == x.getClass(). + *

+ * 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 super.clone 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 super.clone + * need to be modified. + *

+ * The method clone for class Object performs a + * specific cloning operation. First, if the class of this object does + * not implement the interface Cloneable, then a + * CloneNotSupportedException is thrown. Note that all arrays + * are considered to implement the interface Cloneable. + * 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 class Object does not itself implement the interface + * Cloneable, so calling the clone method on an object + * whose class is Object 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 Cloneable interface. Subclasses + * that override the clone method can also + * throw this exception to indicate that an instance cannot + * be cloned. + * @see java.lang.Cloneable + */ + public Object clone() throws CloneNotSupportedException { + CustomTagImpl cti = new CustomTagImpl( this.name, "" ); + cti.value = this.value; + return cti; + } + + public String toString() { + return "[custom name=\""+this.name+"\" value=\""+this.value.toString()+"\"]"; + } + public static class Location { + private String value; + + public Location(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + public Object clone() { + return new Location(this.value); + } + + public String toString() { + return value; + } + + public boolean equals( Object o ){ + if( o instanceof Location && ((Location) o).value.equals(this.value) ) return true; + else return false; + } + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/CustomTags.java b/src/main/java/com/sun/syndication/feed/module/base/CustomTags.java new file mode 100644 index 0000000..fdc456d --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/CustomTags.java @@ -0,0 +1,38 @@ +/* + * CustomTags.java + * + * Created on February 6, 2006, 12:26 AM + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.feed.module.Module; +import java.util.List; + +/** + * @version $Revision: 1.1 $ + * @author Robert "kebernet" Cooper + */ +public interface CustomTags extends Module { + + public static final String URI = "http://base.google.com/cns/1.0"; + + public List getValues(); + + public void setValues(List values); + +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/CustomTagsImpl.java b/src/main/java/com/sun/syndication/feed/module/base/CustomTagsImpl.java new file mode 100644 index 0000000..c9fa0a8 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/CustomTagsImpl.java @@ -0,0 +1,66 @@ +/* + * CustomTagsImpl.java + * + * Created on February 6, 2006, 12:26 AM + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +package com.sun.syndication.feed.module.base; + +import java.util.ArrayList; +import java.util.List; + +/** + * @version $Revision: 1.1 $ + * @author Robert "kebernet" Cooper + */ +public class CustomTagsImpl implements CustomTags { + + private List values; + /** Creates a new instance of CustomTagsImpl */ + public CustomTagsImpl() { + } + + public List getValues(){ + values = (values == null )? new ArrayList() : values; + return values; + } + + public void setValues(List values){ + this.values = values; + } + + public void copyFrom(Object object) { + CustomTags ct = (CustomTags) object; + this.values = new ArrayList( ct.getValues() ); + } + + public Object clone() { + CustomTagsImpl cti = new CustomTagsImpl(); + cti.values = new ArrayList( this.values ); + return cti; + } + + public Class getInterface(){ + return CustomTags.class; + } + + public String getUri() { + return CustomTags.URI; + } + + +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/Event.java b/src/main/java/com/sun/syndication/feed/module/base/Event.java new file mode 100644 index 0000000..8825d66 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/Event.java @@ -0,0 +1,1400 @@ +/* + * Event.java + * + * Created on November 16, 2005, 11:38 AM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.feed.module.base.types.CurrencyEnumeration; +import com.sun.syndication.feed.module.base.types.DateTimeRange; +import com.sun.syndication.feed.module.base.types.FloatUnit; +import com.sun.syndication.feed.module.base.types.PaymentTypeEnumeration; +import com.sun.syndication.feed.module.base.types.PriceTypeEnumeration; +import com.sun.syndication.feed.module.base.types.ShippingType; + + +/** + * This is an interface for the GoogleBase plug in that exposes methods used for + * Event entry types. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public interface Event extends GlobalInterface { + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @param value Currency of the price amount for an item. + */ + public void setCurrency(CurrencyEnumeration value); + + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @return Currency of the price amount for an item. + */ + public CurrencyEnumeration getCurrency(); + + /** + * Additional instructions to explain the item’s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @param deliveryNotes Additional instructions to explain the item’s delivery process. + */ + public void setDeliveryNotes(String deliveryNotes); + + /** + * Additional instructions to explain the item’s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @return Additional instructions to explain the item’s delivery process. + */ + public String getDeliveryNotes(); + + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @param deliveryRadius The maximum distance you will deliver an item in any direction. + */ + public void setDeliveryRadius(FloatUnit deliveryRadius); + + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @return The maximum distance you will deliver an item in any direction. + */ + public FloatUnit getDeliveryRadius(); + + /** + * The time during which this event takes place. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * event_date_range
+ * Details + * + * Information on the date and time an + * event will take place, in ISO 8601 format. Two sub-attributes are included in the event_date_range attribute:
    + * + *
  • from = Date and time an event will begin + * in format YYYY-MM-DDThh:mm:ss
    • + *
  • to = + * (Optional). Date and time an event will end, in format YYYY-MM-DDThh:mm:ss
+ * Example <g:event_dateTime>
+ * + * <g:from>2005-12-20T14:00:00</g:from>
+ * <g:to>2005-12-20T19:00:00</g:to>
+ * + * </g:eventdateTime>
+ * Attribute of + * Events
+ * Content type + * dateTimeRange
+ * @param eventDateRange The time during which this event takes place. + */ + public void setEventDateRange(DateTimeRange eventDateRange); + + /** + * The time during which this event takes place. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * event_date_range
+ * Details + * + * Information on the date and time an + * event will take place, in ISO 8601 format. Two sub-attributes are included in the event_date_range attribute:
    + * + *
  • from = Date and time an event will begin + * in format YYYY-MM-DDThh:mm:ss
    • + *
  • to = + * (Optional). Date and time an event will end, in format YYYY-MM-DDThh:mm:ss
+ * Example <g:event_dateTime>
+ * + * <g:from>2005-12-20T14:00:00</g:from>
+ * <g:to>2005-12-20T19:00:00</g:to>
+ * + * </g:eventdateTime>
+ * Attribute of + * Events
+ * Content type + * dateTimeRange
+ * @return The time during which this event takes place. + */ + public DateTimeRange getEventDateRange(); + + /** + * Location where the event will be held. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @param location Location where the event will be held. + */ + public void setLocation(String location); + + /** + * Location where the event will be held. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @return Location where the event will be held. + */ + public String getLocation(); + + /** + * Payment Methods acceptable for the event. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_accepted
+ * Details 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 + * <payment_accepted> attribute for each acceptable method.
+ * Example + * Acceptable:
+ * <g:payment_accepted>Cash</g:payment_accepted>
+ * + * <g:payment_accepted>Check</g:payment_accepted>
+ * + * <g:payment_accepted>Paypal</g:payment_accepted>
+ * Not acceptable:
+ * <g:payment_accepted>Cash + * Check Paypal</g:payment_accepted>
+ * Attribute of + * Events, Housing, + * Products, Services, Travel, Vehicles
+ * Content type + * paymentMethodEnumeration
+ * @param paymentAccepted Payment Methods acceptable for the event. + */ + public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted); + + /** + * Payment Methods acceptable for the event. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_accepted
+ * Details 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 + * <payment_accepted> attribute for each acceptable method.
+ * Example + * Acceptable:
+ * <g:payment_accepted>Cash</g:payment_accepted>
+ * + * <g:payment_accepted>Check</g:payment_accepted>
+ * + * <g:payment_accepted>Paypal</g:payment_accepted>
+ * Not acceptable:
+ * <g:payment_accepted>Cash + * Check Paypal</g:payment_accepted>
+ * Attribute of + * Events, Housing, + * Products, Services, Travel, Vehicles
+ * Content type + * paymentMethodEnumeration
+ * @return Payment Methods acceptable for the event. + */ + public PaymentTypeEnumeration[] getPaymentAccepted(); + + /** + * Additional information about payment. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * string
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * string
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * string
+ * @param paymentNotes Additional information about payment. + */ + public void setPaymentNotes(String paymentNotes); + + /** + * Additional information about payment. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * string
+ * + * + * @return Additional information about payment. + */ + public String getPaymentNotes(); + + /** + * Price of the event. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * price
+ * + * Details Prices can be a single price, 0 + * (free), or blank if not applicable. Numerice values only. When used + * as a sub-attribute of <shipping>, the value included reflects the price + * of shipping.
+ * Example + * Acceptable:
+ * <g:price>5.95</g:price>
+ * + * <g:price>0</g:price>
+ * Not acceptable:
+ * + * <g:price>5,95</g:price>
+ * <g:price>5.00 – 10.00</g:price>
+ * + * <g:price>100 or best offer</g:price>
+ * <g:price>free</g:price>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content typefloatUnit
+ * @param price Price of the event. + */ + public void setPrice(FloatUnit price); + + /** + * Price of the event. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * price
+ * + * Details Prices can be a single price, 0 + * (free), or blank if not applicable. Numerice values only. When used + * as a sub-attribute of <shipping>, the value included reflects the price + * of shipping.
+ * Example + * Acceptable:
+ * <g:price>5.95</g:price>
+ * + * <g:price>0</g:price>
+ * Not acceptable:
+ * + * <g:price>5,95</g:price>
+ * <g:price>5.00 – 10.00</g:price>
+ * + * <g:price>100 or best offer</g:price>
+ * <g:price>free</g:price>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content typefloatUnit
+ * @return Price of the event. + */ + public FloatUnit getPrice(); + + /** + * Price qualifier for the even cost. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
price_type
DetailsThe type of pricing for the + * item. Acceptable values are "negotiable," or "starting." The default is + * "starting"
ExampleAcceptable:
+ * <g:price_type>starting</g:price_type>
+ * Not acceptable:
+ * <g:price_type>100 OBO</g:price_type>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * priceTypeEnumeration
+ * @param priceType Price qualifier for the even cost. + */ + public void setPriceType(PriceTypeEnumeration priceType); + + /** + * Price qualifier for the even cost. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
price_type
DetailsThe type of pricing for the + * item. Acceptable values are "negotiable," or "starting." The default is + * "starting"
ExampleAcceptable:
+ * <g:price_type>starting</g:price_type>
+ * Not acceptable:
+ * <g:price_type>100 OBO</g:price_type>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * priceTypeEnumeration
+ * @return Price qualifier for the even cost. + */ + public PriceTypeEnumeration getPriceType(); + + /** + * Quantity available. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * quantity
+ * Details 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.
+ * Example + * Acceptable:
+ * <g:quantity>18</g:quantity>
+ * + * <g:quantity>0</g:quantity>
+ * + * Not acceptable:
+ * <g:quantity>out + * of stock</g:quantity>
+ * + * Attribute of + * Events, Products, + * Services, Travel, Vehicles
+ * Content type + * + * integer
+ * @param quantity Quantity available. + */ + public void setQuantity(Integer quantity); + + /** + * Quantity available. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * quantity
+ * Details 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.
+ * Example + * Acceptable:
+ * <g:quantity>18</g:quantity>
+ * + * <g:quantity>0</g:quantity>
+ * + * Not acceptable:
+ * <g:quantity>out + * of stock</g:quantity>
+ * + * Attribute of + * Events, Products, + * Services, Travel, Vehicles
+ * Content type + * + * integer
+ * @return Quantity available. + */ + public Integer getQuantity(); + + /** + * Shipping information related to the event. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * shipping
+ * Details + * 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:
    + * + *
  • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
    • + *
  • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
    • + *
  • price = + * the price of shipping.
+ * + * Example <g:shipping>
+ * <g:country>US</g:country>
+ * + * <g:service>UPS</g:shipping>
+ * + * <g:price>35.95</g:price>
+ * </g:shipping>
+ * Attribute of + * Products
+ * + * Content type + * shippingType
+ * @param shipping Shipping information related to the event. + */ + public void setShipping(ShippingType[] shipping); + + /** + * Shipping information related to the event. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * shipping
+ * Details + * 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:
    + * + *
  • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
    • + *
  • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
    • + *
  • price = + * the price of shipping.
+ * + * Example <g:shipping>
+ * <g:country>US</g:country>
+ * + * <g:service>UPS</g:shipping>
+ * + * <g:price>35.95</g:price>
+ * </g:shipping>
+ * Attribute of + * Products
+ * + * Content type + * shippingType
+ * @return Shipping information related to the event. + */ + public ShippingType[] getShipping(); + + /** + * Tax rate associated with the event. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * tax_percent
+ * + * Details + * Tax rate as a percentage.
+ * Example <g:tax_percent>8.2<g:/tax_percent>
+ * + * Attribute of + * + * Products, Events
+ * Content type + * percentType
+ * @param taxPercent Tax rate associated with the event. + */ + public void setTaxPercent(Float taxPercent); + + /** + * Tax rate associated with the event. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * tax_percent
+ * + * Details + * Tax rate as a percentage.
+ * Example <g:tax_percent>8.2<g:/tax_percent>
+ * + * Attribute of + * + * Products, Events
+ * Content type + * percentType
+ * @return Tax rate associated with the event. + */ + public Float getTaxPercent(); + + /** + * Region where tax applies. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * tax_region
+ * Details + * Geographical region a tax rate + * applies to.
+ * + * Example <g:tax_region>California</g:tax_region>
+ * Attribute of + * Product, + * Events,
+ * Content typestring
+ * @param taxRegion Region where tax applies. + */ + public void setTaxRegion(String taxRegion); + + /** + * Region where tax applies. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * tax_region
+ * Details + * Geographical region a tax rate + * applies to.
+ * + * Example <g:tax_region>California</g:tax_region>
+ * Attribute of + * Product, + * Events,
+ * Content typestring
+ * @return Region where tax applies. + */ + public String getTaxRegion(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/GlobalInterface.java b/src/main/java/com/sun/syndication/feed/module/base/GlobalInterface.java new file mode 100644 index 0000000..65875af --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/GlobalInterface.java @@ -0,0 +1,532 @@ +/* + * GlobalInterface.java + * + * Created on November 16, 2005, 5:27 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import java.io.Serializable; +import java.net.URL; +import java.util.Date; + + +/** + * This is an interface representing the universals. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.2 $ + */ +public interface GlobalInterface extends Serializable { + /**Expiration Date for this item. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
expiration_date
Details Date that the item expires in ISO 8601 format: + * YYYY-MM-DD
Example + * <g:expiration_date>2005-20-12</g:expiration_date> + * + *
Attribute of Reference Items, Events, Housing, + * Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.
Content type date
+ * @param expirationDate the date this entry will expire + */ + public void setExpirationDate(Date expirationDate); + + /** Expiration Date for this item. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
expiration_date
Details Date that the item expires in ISO 8601 format: + * YYYY-MM-DD
Example + * <g:expiration_date>2005-20-12</g:expiration_date> + * + *
Attribute of Reference Items, Events, Housing, + * Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.
Content type date
+ * @return the date this entry will expire + */ + public Date getExpirationDate(); + + /** + * Date and time that the item expires. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
expiration_date_time
Details Date and time that the item expires in ISO 8601 format: + * YYYY-MM-DDThh:mm:ss
Example + * <g:expiration_date_time>12-20-05T11:59:59</g:expiration_date_time> + *
Attribute of Reference Items, Events, Housing, + * Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.
Content type dateTime
+ * @param expirationDateTime Date and time that the item expires. + */ + public void setExpirationDateTime(Date expirationDateTime); + + /** + * Date and time that the item expires. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
expiration_date_time
Details Date and time that the item expires in ISO 8601 format: + * YYYY-MM-DDThh:mm:ss
Example + * <g:expiration_date_time>12-20-05T11:59:59</g:expiration_date_time> + *
Attribute of Reference Items, Events, Housing, + * Jobs, People profiles, Products, Services, Travel, Vehicles, Wanted Ads.
Content type dateTime
+ * @return Date and time that the item expires. + */ + public Date getExpirationDateTime(); + + /** Unique id for this item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
id
Details Unique alphanumeric identifier for each item + * - e.g., your internal ID code.
+ * 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.
Example + * + * <g:id>01flx</g:id>
Attribute of Reference Items, Events, Housing, + * Jobs, News and Articles, People profiles, Products, Reviews, Services, + * Travel, Vehicles, Wanted Ads.
Content type string
+ * @param id unique identifier for this entry + */ + public void setId(String id); + + /** Unique id for this item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
id
Details Unique alphanumeric identifier for each item + * - e.g., your internal ID code.
+ * 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.
Example + * + * <g:id>01flx</g:id>
Attribute of Reference Items, Events, Housing, + * Jobs, News and Articles, People profiles, Products, Reviews, Services, + * Travel, Vehicles, Wanted Ads.
Content type string
+ * @return unique identifier for this entry + */ + public String getId(); + + /**Images for this item. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
image_link
Details 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 <image_link> + * and </image_link> 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.
Example Acceptable:
+ * <image_link>http://example.com/images/1006.jpg</image_link>
+ * + * <image_link>http://example.com/i/6.jpg,http://example.com/i/9.jpg</image_link>
+ * + * Not acceptable:
+ * <image_link>/images/1006.jpg</image_link>
+ * <image_link>example.com/images/1006.jpg</image_link>
Attribute of Reference Items, Events, Housing, + * Jobs, News and Articles, People profiles, Products, Reviews, Services, + * Travel, Vehicles, Wanted Ads.
Content type url
+ * @param imageLinks URLs to images. Limit 10. + */ + public void setImageLinks(URL[] imageLinks); + + /**Images for this item. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
image_link
Details 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 <image_link> + * and </image_link> 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.
Example Acceptable:
+ * <image_link>http://example.com/images/1006.jpg</image_link>
+ * + * <image_link>http://example.com/i/6.jpg,http://example.com/i/9.jpg</image_link>
+ * + * Not acceptable:
+ * <image_link>/images/1006.jpg</image_link>
+ * <image_link>example.com/images/1006.jpg</image_link>
Attribute of Reference Items, Events, Housing, + * Jobs, News and Articles, People profiles, Products, Reviews, Services, + * Travel, Vehicles, Wanted Ads.
Content type url
+ * @return URLs to images + */ + public URL[] getImageLinks(); + + /**Labels for this item. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * label
+ * + * Details + * A + * list of classifications the item may fall under. Up to ten user-selected + * label, each placed in between their own <label> + * + * and </label> 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.
+ * Example + * + * Acceptable:
+ * For an automobile in a Vehicles information type:
+ * + * + * <g:label>Leather</g:label>
+ * + * <g:label>Power locks</g:label>
+ * + * + * <g:label>sunroof</g:label>
+ * + * + * <g:label>ABS</g:label>

+ * + * For a concert in an Events information type:
+ * + * <g:label>VIP</g:label>
+ * + * + * <g:label>front row</g:label>
+ * + * <g:label>backstage</g:label>
+ * + * + * + * <g:label>KROCK 101.5</g:label>
+ * + * <g:label>parking passes</g:label>

+ * + * Not acceptable:
+ * + * + * <g:label> leater, power locks, sunroof, ABS </g:label>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * + * string
+ * @param labels labels for this entry. Limit 10. + */ + public void setLabels(String[] labels); + + /**Labels for this item. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * label
+ * + * Details + * A + * list of classifications the item may fall under. Up to ten user-selected + * label, each placed in between their own <label> + * + * and </label> 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.
+ * Example + * + * Acceptable:
+ * For an automobile in a Vehicles information type:
+ * + * + * <g:label>Leather</g:label>
+ * + * <g:label>Power locks</g:label>
+ * + * + * <g:label>sunroof</g:label>
+ * + * + * <g:label>ABS</g:label>

+ * + * For a concert in an Events information type:
+ * + * <g:label>VIP</g:label>
+ * + * + * <g:label>front row</g:label>
+ * + * <g:label>backstage</g:label>
+ * + * + * + * <g:label>KROCK 101.5</g:label>
+ * + * <g:label>parking passes</g:label>

+ * + * Not acceptable:
+ * + * + * <g:label> leater, power locks, sunroof, ABS </g:label>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * + * string
+ * @return labels for this entry + */ + public String[] getLabels(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/GoogleBase.java b/src/main/java/com/sun/syndication/feed/module/base/GoogleBase.java new file mode 100644 index 0000000..850adb0 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/GoogleBase.java @@ -0,0 +1,62 @@ +/* + * GoogleBase.java + * + * Created on November 16, 2005, 4:37 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.feed.module.Module; + + +/** + * This is the root interface for the Google Base module. + * + *

+ * 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. + *

+ * + * @author Robert "kebernet" + * Cooper + * @version $Revision: 1.1 $ + */ +public interface GoogleBase extends Module,Article,Course,Event,Job,Person,Product,Review,ScholarlyArticle,Service,Travel,Unknown,Vehicle,Wanted,Housing { + /** This is the URI for the Google Base Schema. */ + public static final String URI = "http://base.google.com/ns/1.0"; +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/GoogleBaseImpl.java b/src/main/java/com/sun/syndication/feed/module/base/GoogleBaseImpl.java new file mode 100644 index 0000000..de55bbe --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/GoogleBaseImpl.java @@ -0,0 +1,1253 @@ +/* + * GoogleBaseImpl.java + * + * Created on November 16, 2005, 2:06 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.feed.impl.EqualsBean; + +import com.sun.syndication.feed.module.base.types.CloneableType; +import com.sun.syndication.feed.module.base.types.CurrencyEnumeration; +import com.sun.syndication.feed.module.base.types.DateTimeRange; +import com.sun.syndication.feed.module.base.types.FloatUnit; +import com.sun.syndication.feed.module.base.types.GenderEnumeration; +import com.sun.syndication.feed.module.base.types.IntUnit; +import com.sun.syndication.feed.module.base.types.PaymentTypeEnumeration; +import com.sun.syndication.feed.module.base.types.PriceTypeEnumeration; +import com.sun.syndication.feed.module.base.types.ShippingType; +import com.sun.syndication.feed.module.base.types.ShortDate; +import com.sun.syndication.feed.module.base.types.Size; +import com.sun.syndication.feed.module.base.types.YearType; + +import java.lang.reflect.Array; + +import java.net.URL; + +import java.util.Date; + + +/** + * This is the implementation class for the GoogleBase module interface. + * + * @author Robert "kebernet" + * Cooper + * @version $Revision: 1.2 $ + */ +public class GoogleBaseImpl implements GoogleBase { + /** boolean:listing_type */ + private Boolean listingType; + + /** Can this item be picked up. */ + private Boolean pickup; + + /** currencyCodeEnumeration:currency */ + private CurrencyEnumeration currency; + + /** dateTime:expiration_date_time */ + private Date expirationDateTime; + + /** dateTimeRange:course_date_range */ + private DateTimeRange courseDateRange; + + /** dateTimeRange:event_date_range */ + private DateTimeRange eventDateRange; + + /** dateTimeRange:travel_date_range */ + private DateTimeRange travelDateRange; + + /** float:bathrooms */ + private Float bathrooms; + + /** float:hoa_dues */ + private Float hoaDues; + + /** string:rating thoug this a value from 1 to 5 */ + private Float rating; + + /** float:salary */ + private Float salary; + + /** percentType:tax_percent */ + private Float taxPercent; + + /** floatUnit:delivery_radius */ + private FloatUnit deliveryRadius; + + /** floatUnit:megapixels */ + private FloatUnit megapixels; + + /** floatUnit:memory */ + private FloatUnit memory; + + /** floatUnit:price */ + private FloatUnit price; + + /** floatUnit:processor_speed */ + private FloatUnit processorSpeed; + + /** floatUnit:weight */ + private FloatUnit weight; + + /** genderEnumeration:gender */ + private GenderEnumeration gender; + + /** intUnit:area */ + private IntUnit area; + + /** integer:age */ + private Integer age; + + /** integer:bedrooms */ + private Integer bedrooms; + + /** integer:mileage */ + private Integer mileage; + + /** integer:pages */ + private Integer pages; + + /** integer:quantity */ + private Integer quantity; + + /** locationType:from_location */ + private String fromLocation; + + /** locationType:location */ + private String location; + + /** locationType:to_location */ + private String toLocation; + + /** priceTypeEnumeration:price_type */ + private PriceTypeEnumeration priceType; + + /** starting/neg:salary_type */ + private PriceTypeEnumeration salaryType; + + /** date:expiration_date */ + private ShortDate expirationDate; + + /** date:publishedDate */ + private ShortDate publishDate; + + /** string:size */ + private Size size; + + /** string:sexual_orientation */ + private String SexualOrientation; + + /** string apparel_type */ + private String apparelType; + + /** string:brand */ + private String brand; + + /** string:condition */ + private String condition; + + /** string:course_number */ + private String courseNumber; + + /** string:course_times */ + private String courseTimes; + + /** string:delivery_notes */ + private String deliveryNotes; + + /** string:education */ + private String education; + + /** string:employer */ + private String employer; + + /** string:id */ + private String id; + + /** string:immigration_status */ + private String immigrationStatus; + + /** stirng:isbn */ + private String isbn; + + /** string:make */ + private String make; + + /** string:manufacturer */ + private String manufacturer; + + /** string:manufacturer_id */ + private String manufacturerId; + + /** string:marital_status */ + private String maritalStatus; + + /** string:model */ + private String model; + + /** string:model_number */ + private String modelNumber; + + /** string:name_of_item_being_reviewed */ + private String nameOfItemBeingReviewed; + + /** string:news_source */ + private String newsSource; + + /** string:occupation */ + private String occupation; + + /** string:operating_systems */ + private String operatingSystems; + + /** string:payment_notes */ + private String paymentNotes; + + /** string:publication_name */ + private String publicationName; + + /** string:publication_volume */ + private String publicationVolume; + + /** string:review_type */ + private String reviewType; + + /** string:reviewer_type */ + private String reviewerType; + + /** string:school_district */ + private String schoolDistrict; + + /** string:service_type */ + private String serviceType; + + /** string:taxRegion */ + private String taxRegion; + + /** string:university */ + private String university; + + /** string:upc */ + private String upc; + + /** string:vehicle_type */ + private String vehicleType; + + /** string:vin */ + private String vin; + + /** string:url_of_item_being_reviewed */ + private URL urlOfItemBeingReviewed; + + /** string:year */ + private YearType year; + + /** string:actor */ + private String[] actors; + + /** string:agent */ + private String[] agents; + + /** string:artist */ + private String[] artists; + + /** string:author */ + private String[] authors; + + /** string:color */ + private String[] color; + + /** string:ethnicities */ + private String[] ethnicities; + + /** string:format */ + private String[] format; + + /** url:image_links */ + private URL[] imageLinks; + + /** string:interested_in */ + private String[] interestedIn; + + /** string:job_function */ + private String[] jobFunctions; + + /** string:job_industry */ + private String[] jobIndustries; + + /** string:job_type */ + private String[] jobTypes; + + /** string:label */ + private String[] labels; + + /** string:license */ + private String[] licenses; + + /** paymentTypeEnumeration:payment_accepted */ + private PaymentTypeEnumeration[] paymentAccepted; + + /** string:product_type */ + private String[] productTypes; + + /** string:programming_language */ + private String[] programmingLanguages; + + /** string:property_type */ + private String[] propertyTypes; + + /** url:related_link */ + private URL[] relatedLinks; + + /** shippingType:shipping */ + private ShippingType[] shipping; + + /** intUnitType:square_footage */ + private IntUnit[] squareFootages; + + /** string:subject_area */ + private String[] subjectAreas; + + /** string:subject */ + private String[] subjects; + + /** + * DOCUMENT ME! + * + * @param actors + */ + public void setActors(String[] actors) { + this.actors = actors; + } + + public String[] getActors() { + return actors == null ? new String[0] : actors; + } + + public void setAge(Integer age) { + this.age = age; + } + + public Integer getAge() { + return age; + } + + public void setAgents(String[] agents) { + this.agents = agents == null ? new String[0] : agents; + } + + public String[] getAgents() { + return agents; + } + + public void setApparelType(String apparelType) { + this.apparelType = apparelType; + } + + public String getApparelType() { + return apparelType; + } + + public void setArea(IntUnit area) { + this.area = area; + } + + public IntUnit getArea() { + return area; + } + + public void setArtists(String[] artists) { + this.artists = artists; + } + + public String[] getArtists() { + return artists == null ? new String[0] : artists; + } + + public void setAuthors(String[] authors) { + this.authors = authors; + } + + public String[] getAuthors() { + return authors == null ? new String[0] : authors; + } + + public void setBathrooms(Float bathrooms) { + this.bathrooms = bathrooms; + } + + public Float getBathrooms() { + return bathrooms; + } + + public void setBedrooms(Integer bedrooms) { + this.bedrooms = bedrooms; + } + + public Integer getBedrooms() { + return bedrooms; + } + + public void setBrand(String brand) { + this.brand = brand; + } + + public String getBrand() { + return brand; + } + + public void setColors(String[] color) { + this.color = color; + } + + public String[] getColors() { + return color == null ? new String[0] : color; + } + + public void setCondition(String condition) { + this.condition = condition; + } + + public String getCondition() { + return condition; + } + + public void setCourseDateRange(DateTimeRange courseDateRange) { + this.courseDateRange = courseDateRange; + } + + public DateTimeRange getCourseDateRange() { + return courseDateRange; + } + + public void setCourseNumber(String courseNumber) { + this.courseNumber = courseNumber; + } + + public String getCourseNumber() { + return courseNumber; + } + + public void setCourseTimes(String courseTimes) { + this.courseTimes = courseTimes; + } + + public String getCourseTimes() { + return courseTimes; + } + + public void setCurrency(CurrencyEnumeration currency) { + this.currency = currency; + } + + public CurrencyEnumeration getCurrency() { + return currency; + } + + public void setDeliveryNotes(String deliveryNotes) { + this.deliveryNotes = deliveryNotes; + } + + public String getDeliveryNotes() { + return deliveryNotes; + } + + public void setDeliveryRadius(FloatUnit deliveryRadius) { + this.deliveryRadius = deliveryRadius; + } + + public FloatUnit getDeliveryRadius() { + return deliveryRadius; + } + + public void setEducation(String education) { + this.education = education; + } + + public String getEducation() { + return education; + } + + public void setEmployer(String employer) { + this.employer = employer; + } + + public String getEmployer() { + return employer; + } + + public void setEthnicities(String[] ethnicities) { + this.ethnicities = ethnicities; + } + + public String[] getEthnicities() { + return ethnicities == null ? new String[0] : ethnicities; + } + + public void setEventDateRange(DateTimeRange eventDateRange) { + this.eventDateRange = eventDateRange; + } + + public DateTimeRange getEventDateRange() { + return eventDateRange; + } + + public void setExpirationDate(Date expirationDate) { + if((expirationDate != null)&&!(expirationDate instanceof ShortDate)) { + this.expirationDate = new ShortDate(expirationDate); + } else { + this.expirationDate = null; + } + } + + public Date getExpirationDate() { + return expirationDate; + } + + public void setExpirationDateTime(Date expirationDateTime) { + this.expirationDateTime = expirationDateTime; + } + + public Date getExpirationDateTime() { + return expirationDateTime; + } + + public void setFormat(String[] format) { + this.format = format; + } + + public String[] getFormat() { + return format == null ? new String[0] : format; + } + + public void setFromLocation(String fromLocation) { + this.fromLocation = fromLocation; + } + + public String getFromLocation() { + return fromLocation; + } + + public void setGender(GenderEnumeration gender) { + this.gender = gender; + } + + public GenderEnumeration getGender() { + return gender; + } + + public void setHoaDues(Float hoaDues) { + this.hoaDues = hoaDues; + } + + public Float getHoaDues() { + return hoaDues; + } + + public void setId(String id) { + this.id = id; + } + + public String getId() { + return id; + } + + public void setImageLinks(URL[] imageLinks) { + this.imageLinks = imageLinks; + } + + public URL[] getImageLinks() { + return imageLinks == null ? new URL[0] : imageLinks; + } + + public void setImmigrationStatus(String immigrationStatus) { + this.immigrationStatus = immigrationStatus; + } + + public String getImmigrationStatus() { + return immigrationStatus; + } + + public void setInterestedIn(String[] interestedIn) { + this.interestedIn = interestedIn; + } + + public String[] getInterestedIn() { + return interestedIn == null ? new String[0] : interestedIn; + } + + public Class getInterface() { + return GoogleBase.class; + } + + public void setIsbn(String isbn) { + this.isbn = isbn; + } + + public String getIsbn() { + return isbn; + } + + public void setJobFunctions(String[] jobFunctions) { + this.jobFunctions = jobFunctions; + } + + public String[] getJobFunctions() { + return jobFunctions == null ? new String[0] : jobFunctions; + } + + public void setJobIndustries(String[] jobIndustries) { + this.jobIndustries = jobIndustries; + } + + public String[] getJobIndustries() { + return jobIndustries == null ? new String[0] : jobIndustries; + } + + public void setJobTypes(String[] jobTypes) { + this.jobTypes = jobTypes; + } + + public String[] getJobTypes() { + return jobTypes == null ? new String[0] : jobTypes; + } + + public void setLabels(String[] labels) { + this.labels = labels; + } + + public String[] getLabels() { + return labels == null ? new String[0] : labels; + } + + public void setLicenses(String[] licenses) { + this.licenses = licenses; + } + + public String[] getLicenses() { + return licenses == null ? new String[0] : licenses; + } + + public void setListingType(Boolean listingType) { + this.listingType = listingType; + } + + public Boolean getListingType() { + return listingType; + } + + public void setLocation(String location) { + this.location = location; + } + + public String getLocation() { + return location; + } + + public void setMake(String make) { + this.make = make; + } + + public String getMake() { + return make; + } + + public void setManufacturer(String manufacturer) { + this.manufacturer = manufacturer; + } + + public String getManufacturer() { + return manufacturer; + } + + public void setManufacturerId(String manufacturerId) { + this.manufacturerId = manufacturerId; + } + + public String getManufacturerId() { + return manufacturerId; + } + + public void setMaritalStatus(String maritalStatus) { + this.maritalStatus = maritalStatus; + } + + public String getMaritalStatus() { + return maritalStatus; + } + + public void setMegapixels(FloatUnit megapixels) { + this.megapixels = megapixels; + } + + public FloatUnit getMegapixels() { + return megapixels; + } + + public void setMemory(FloatUnit memory) { + this.memory = memory; + } + + public FloatUnit getMemory() { + return memory; + } + + public void setMileage(Integer mileage) { + this.mileage = mileage; + } + + public Integer getMileage() { + return mileage; + } + + public void setModel(String model) { + this.model = model; + } + + public String getModel() { + return model; + } + + public void setModelNumber(String modelNumber) { + this.modelNumber = modelNumber; + } + + public String getModelNumber() { + return modelNumber; + } + + public void setNameOfItemBeingReviewed(String nameOfItemBeingReviewed) { + this.nameOfItemBeingReviewed = nameOfItemBeingReviewed; + } + + public String getNameOfItemBeingReviewed() { + return nameOfItemBeingReviewed; + } + + public void setNewsSource(String newsSource) { + this.newsSource = newsSource; + } + + public String getNewsSource() { + return newsSource; + } + + public void setOccupation(String occupation) { + this.occupation = occupation; + } + + public String getOccupation() { + return occupation; + } + + public void setOperatingSystems(String operatingSystems) { + this.operatingSystems = operatingSystems; + } + + public String getOperatingSystems() { + return operatingSystems; + } + + public void setPages(Integer pages) { + this.pages = pages; + } + + public Integer getPages() { + return pages; + } + + public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted) { + this.paymentAccepted = paymentAccepted; + } + + public PaymentTypeEnumeration[] getPaymentAccepted() { + return paymentAccepted == null ? new PaymentTypeEnumeration[0] : paymentAccepted; + } + + public void setPaymentNotes(String paymentNotes) { + this.paymentNotes = paymentNotes; + } + + public String getPaymentNotes() { + return paymentNotes; + } + + public void setPickup(Boolean pickup) { + this.pickup = pickup; + } + + public Boolean getPickup() { + return pickup; + } + + public void setPrice(FloatUnit price) { + this.price = price; + } + + public FloatUnit getPrice() { + return price; + } + + public void setPriceType(PriceTypeEnumeration priceType) { + this.priceType = priceType; + } + + public PriceTypeEnumeration getPriceType() { + return priceType; + } + + public void setProcessorSpeed(FloatUnit processorSpeed) { + this.processorSpeed = processorSpeed; + } + + public FloatUnit getProcessorSpeed() { + return processorSpeed; + } + + public void setProductTypes(String[] productTypes) { + this.productTypes = productTypes; + } + + public String[] getProductTypes() { + return productTypes == null ? new String[0] : productTypes; + } + + public void setProgrammingLanguages(String[] programmingLanguages) { + this.programmingLanguages = programmingLanguages; + } + + public String[] getProgrammingLanguages() { + return programmingLanguages == null ? new String[0] : programmingLanguages; + } + + public void setPropertyTypes(String[] propertyTypes) { + this.propertyTypes = propertyTypes; + } + + public String[] getPropertyTypes() { + return propertyTypes == null ? new String[0] : propertyTypes; + } + + public void setPublicationName(String publicationName) { + this.publicationName = publicationName; + } + + public String getPublicationName() { + return publicationName; + } + + public void setPublicationVolume(String publicationVolume) { + this.publicationVolume = publicationVolume; + } + + public String getPublicationVolume() { + return publicationVolume; + } + + public void setPublishDate(Date publishDate) { + if((publishDate != null)&&!(publishDate instanceof ShortDate)) { + this.publishDate = new ShortDate(publishDate); + } else { + this.publishDate = null; + } + } + + public Date getPublishDate() { + return publishDate; + } + + public void setQuantity(Integer quantity) { + this.quantity = quantity; + } + + public Integer getQuantity() { + return quantity; + } + + public void setRating(Float rating) { + this.rating = rating; + } + + public Float getRating() { + return rating; + } + + public void setRelatedLinks(URL[] relatedLinks) { + this.relatedLinks = relatedLinks; + } + + public URL[] getRelatedLinks() { + return relatedLinks == null ? new URL[0] : relatedLinks; + } + + public void setReviewType(String reviewType) { + this.reviewType = reviewType; + } + + public String getReviewType() { + return reviewType; + } + + public void setReviewerType(String reviewerType) { + this.reviewerType = reviewerType; + } + + public String getReviewerType() { + return reviewerType; + } + + public void setSalary(Float salary) { + this.salary = salary; + } + + public Float getSalary() { + return salary; + } + + public void setSalaryType(PriceTypeEnumeration salaryType) { + this.salaryType = salaryType; + } + + public PriceTypeEnumeration getSalaryType() { + return salaryType; + } + + public void setSchoolDistrict(String schoolDistrict) { + this.schoolDistrict = schoolDistrict; + } + + public String getSchoolDistrict() { + return schoolDistrict; + } + + public void setServiceType(String serviceType) { + this.serviceType = serviceType; + } + + public String getServiceType() { + return serviceType; + } + + public void setSexualOrientation(String SexualOrientation) { + this.SexualOrientation = SexualOrientation; + } + + public String getSexualOrientation() { + return SexualOrientation; + } + + public void setShipping(ShippingType[] shipping) { + this.shipping = shipping; + } + + public ShippingType[] getShipping() { + return shipping == null ? new ShippingType[0] : shipping; + } + + public void setSize(Size size) { + this.size = size; + } + + public Size getSize() { + return size; + } + + public void setSquareFootages(IntUnit[] squareFootages) { + this.squareFootages = squareFootages; + } + + public IntUnit[] getSquareFootages() { + return squareFootages == null ? new IntUnit[0] : squareFootages; + } + + public void setSubjectAreas(String[] subjectAreas) { + this.subjectAreas = subjectAreas; + } + + public String[] getSubjectAreas() { + return subjectAreas == null ? new String[0] : subjectAreas; + } + + public void setSubjects(String[] subjects) { + this.subjects = subjects; + } + + public String[] getSubjects() { + return subjects == null ? new String[0] : subjects; + } + + public void setTaxPercent(Float taxPercent) { + this.taxPercent = taxPercent; + } + + public Float getTaxPercent() { + return taxPercent; + } + + public void setTaxRegion(String taxRegion) { + this.taxRegion = taxRegion; + } + + public String getTaxRegion() { + return taxRegion; + } + + public void setToLocation(String toLocation) { + this.toLocation = toLocation; + } + + public String getToLocation() { + return toLocation; + } + + public void setTravelDateRange(DateTimeRange travelDateRange) { + this.travelDateRange = travelDateRange; + } + + public DateTimeRange getTravelDateRange() { + return travelDateRange; + } + + public void setUniversity(String university) { + this.university = university; + } + + public String getUniversity() { + return university; + } + + public void setUpc(String upc) { + this.upc = upc; + } + + public String getUpc() { + return upc; + } + + public String getUri() { + return GoogleBase.URI; + } + + public void setUrlOfItemBeingReviewed(URL urlOfItemBeingReviewed) { + this.urlOfItemBeingReviewed = urlOfItemBeingReviewed; + } + + public URL getUrlOfItemBeingReviewed() { + return urlOfItemBeingReviewed; + } + + public void setVehicleType(String vehicleType) { + this.vehicleType = vehicleType; + } + + public String getVehicleType() { + return vehicleType; + } + + public void setVin(String vin) { + this.vin = vin; + } + + public String getVin() { + return vin; + } + + public void setWeight(FloatUnit weight) { + this.weight = weight; + } + + public FloatUnit getWeight() { + return weight; + } + + public void setYear(YearType year) { + this.year = year; + } + + public YearType getYear() { + return year; + } + + //TODO: Finish + public Object clone() throws CloneNotSupportedException { + try { + GoogleBaseImpl gbi = new GoogleBaseImpl(); + gbi.copyFrom(this); + + return gbi; + } catch(Exception e) { + e.printStackTrace(); + throw new CloneNotSupportedException(); + } + } + + public void copyFrom(Object obj) { + if(!(obj instanceof GoogleBase)) { + return; + } + + GoogleBase source = (GoogleBase)obj; + + this.setActors((String[])arrayCopy(source.getActors())); + this.setAge(source.getAge()); + this.setAgents((String[])arrayCopy(source.getAgents())); + this.setApparelType(source.getApparelType()); + this.setArea(source.getArea()); + this.setArtists((String[])arrayCopy(source.getArtists())); + this.setAuthors((String[])arrayCopy(source.getAuthors())); + this.setBathrooms(source.getBathrooms()); + this.setBedrooms(source.getBedrooms()); + this.setBrand(source.getBrand()); + this.setColors((String[])arrayCopy(source.getColors())); + this.setCondition(source.getCondition()); + this.setCourseDateRange((DateTimeRange)cloneOrNull(source.getCourseDateRange())); + this.setCourseNumber(source.getCourseNumber()); + this.setCourseTimes(source.getCourseTimes()); + this.setDeliveryNotes(source.getDeliveryNotes()); + this.setDeliveryRadius(source.getDeliveryRadius()); + this.setEducation(source.getEducation()); + this.setEmployer(source.getEmployer()); + this.setEthnicities((String[])arrayCopy(source.getEthnicities())); + this.setEventDateRange((DateTimeRange)cloneOrNull(source.getEventDateRange())); + this.setExpirationDate(dateOrNull(source.getExpirationDate())); + this.setExpirationDateTime(dateOrNull(source.getExpirationDateTime())); + this.setFormat(source.getFormat()); + this.setFromLocation(source.getFromLocation()); + this.setGender(source.getGender()); + this.setHoaDues(source.getHoaDues()); + this.setId(source.getId()); + this.setImageLinks((URL[])arrayCopy(source.getImageLinks())); + this.setImmigrationStatus(source.getImmigrationStatus()); + this.setInterestedIn(source.getInterestedIn()); + this.setIsbn(source.getIsbn()); + this.setJobFunctions((String[])arrayCopy(source.getJobFunctions())); + this.setJobIndustries((String[])arrayCopy(source.getJobIndustries())); + this.setJobTypes((String[])arrayCopy(source.getJobTypes())); + this.setLabels((String[])arrayCopy(source.getLabels())); + this.setListingType(source.getListingType()); + this.setLocation(source.getLocation()); + this.setMake(source.getMake()); + this.setManufacturer(source.getManufacturer()); + this.setManufacturerId(source.getManufacturerId()); + this.setMaritalStatus(source.getMaritalStatus()); + this.setMegapixels(source.getMegapixels()); + this.setMemory(source.getMemory()); + this.setMileage(source.getMileage()); + this.setModel(source.getModel()); + this.setModelNumber(source.getModelNumber()); + this.setNameOfItemBeingReviewed(source.getNameOfItemBeingReviewed()); + this.setNewsSource(source.getNewsSource()); + this.setOccupation(source.getOccupation()); + this.setPages(source.getPages()); + this.setPaymentAccepted((PaymentTypeEnumeration[])arrayCopy(source.getPaymentAccepted())); + this.setPaymentNotes(source.getPaymentNotes()); + this.setPickup(source.getPickup()); + this.setPrice(source.getPrice()); + this.setPriceType(source.getPriceType()); + this.setProcessorSpeed(source.getProcessorSpeed()); + this.setProductTypes((String[])arrayCopy(source.getProductTypes())); + this.setPropertyTypes((String[])arrayCopy(source.getPropertyTypes())); + this.setPublicationName(source.getPublicationName()); + this.setPublicationVolume(source.getPublicationVolume()); + this.setPublishDate(dateOrNull(source.getPublishDate())); + this.setQuantity(source.getQuantity()); + this.setRating(source.getRating()); + this.setReviewType(source.getReviewType()); + this.setReviewerType(source.getReviewerType()); + this.setSalary(source.getSalary()); + this.setSalaryType(source.getSalaryType()); + this.setServiceType(source.getServiceType()); + this.setSexualOrientation(source.getSexualOrientation()); + this.setShipping((ShippingType[])arrayCopy(source.getShipping())); + this.setSize(source.getSize()); + this.setSubjects((String[])arrayCopy(source.getSubjects())); + this.setTaxPercent(source.getTaxPercent()); + this.setTaxRegion(source.getTaxRegion()); + this.setToLocation(source.getToLocation()); + this.setTravelDateRange((DateTimeRange)cloneOrNull(source.getTravelDateRange())); + this.setUpc(source.getUpc()); + this.setUrlOfItemBeingReviewed(source.getUrlOfItemBeingReviewed()); + this.setVehicleType(source.getVehicleType()); + this.setVin(source.getVin()); + this.setYear(source.getYear()); + this.setLicenses((String[])arrayCopy(source.getLicenses())); + this.setRelatedLinks((URL[])arrayCopy(source.getRelatedLinks())); + this.setSubjectAreas((String[])arrayCopy(source.getSubjectAreas())); + this.setProgrammingLanguages((String[])arrayCopy(source.getProgrammingLanguages())); + this.setSquareFootages(((IntUnit[])arrayCopy(source.getSquareFootages()))); + this.setCurrency(source.getCurrency()); + this.setSchoolDistrict(source.getSchoolDistrict()); + this.setUniversity(source.getUniversity()); + this.setWeight(source.getWeight()); + this.setOperatingSystems(source.getOperatingSystems()); + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(this.getClass(),this); + + return eBean.beanEquals(obj); + } + + private Object arrayCopy(Object[] source) { + if(source == null) { + return null; + } + + Object[] array = (Object[])Array.newInstance(source.getClass().getComponentType(),source.length); + + for(int i = 0; i < source.length; i++) { + array[i] = source[i]; + } + + return array; + } + + private Object cloneOrNull(CloneableType o) { + if(o == null) { + return null; + } else { + return o.clone(); + } + } + + private Date dateOrNull(Date date) { + if(date == null) { + return null; + } else { + return new Date(date.getTime()); + } + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/Housing.java b/src/main/java/com/sun/syndication/feed/module/base/Housing.java new file mode 100644 index 0000000..fd25b53 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/Housing.java @@ -0,0 +1,1563 @@ +/* + * Housing.java + * + * Created on November 16, 2005, 12:48 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.feed.module.base.types.CurrencyEnumeration; +import com.sun.syndication.feed.module.base.types.FloatUnit; +import com.sun.syndication.feed.module.base.types.IntUnit; +import com.sun.syndication.feed.module.base.types.PaymentTypeEnumeration; +import com.sun.syndication.feed.module.base.types.PriceTypeEnumeration; +import com.sun.syndication.feed.module.base.types.YearType; + + +/** + * This is an interface for the GoogleBase plug in that exposes methods used for + * Housing entry types. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public interface Housing extends GlobalInterface { + /** + * An array of agent name Strings, not to exceed 10 in lenght. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
agent
DetailsIndividual who is negotiating and arranging the real estate sale.
Example<g:agent>Sue Smith</g:agent>
Attribute ofHousing
Content typestring
+ * @param agents An array of agent name Strings, not to exceed 10 in lenght. + */ + public void setAgents(String[] agents); + + /** + * An array of agent name Strings, not to exceed 10 in lenght. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
agent
DetailsIndividual who is negotiating and arranging the real estate sale.
Example<g:agent>Sue Smith</g:agent>
Attribute ofHousing
Content typestring
+ * @return An array of agent name Strings, not to exceed 10 in lenght. + */ + public String[] getAgents(); + + /** + * The area of the real estate. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
area
DetailsThe size of an area of real estate.
Example<g:area>1000</g:area>
Attribute ofHousing
Content typeintUnit
+ * @param area The area of the real estate + */ + public void setArea(IntUnit area); + + /** + * The area of the real estate. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
area
DetailsThe size of an area of real estate.
Example<g:area>1000</g:area>
Attribute ofHousing
Content typeintUnit
+ * @return The area of the real estate + */ + public IntUnit getArea(); + + /** + * The number of bathrooms. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * bathrooms
+ * + * Details + * + * Number of bathrooms. Numeric + * values only.
+ * Example + * Acceptable:
+ * + * <g:bathrooms>2</g:bathrooms>
+ * Not acceptable:
+ * <g:bathrooms>2 bathrooms</g:bathrooms>
+ * + * Attribute of + * Housing
+ * Content type + * float
+ * @param bathrooms The number of bathrooms. + */ + public void setBathrooms(Float bathrooms); + + /** + * The number of bathrooms. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * bathrooms
+ * + * Details + * + * Number of bathrooms. Numeric + * values only.
+ * Example + * Acceptable:
+ * + * <g:bathrooms>2</g:bathrooms>
+ * Not acceptable:
+ * <g:bathrooms>2 bathrooms</g:bathrooms>
+ * + * Attribute of + * Housing
+ * Content type + * float
+ * @return number of bathrooms + */ + public Float getBathrooms(); + + /** + * Number of bedrooms. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
bedrooms
Details Number of bedrooms. Numeric values + * only.
Example Acceptable:
<g:bedrooms>3</g:bedrooms>
+ * Not acceptable:
+ * + * <g:bedrooms>3 bedrooms</g:bedrooms>
Attribute of Housing
Content type integer
+ * @param bedrooms Number of bedrooms. + */ + public void setBedrooms(Integer bedrooms); + + /** + * Number of bedrooms. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
bedrooms
Details Number of bedrooms. Numeric values + * only.
Example Acceptable:
<g:bedrooms>3</g:bedrooms>
+ * Not acceptable:
+ * + * <g:bedrooms>3 bedrooms</g:bedrooms>
Attribute of Housing
Content type integer
+ * @return Number of bedrooms + */ + public Integer getBedrooms(); + + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @param value Currency of the price amount for an item. + */ + public void setCurrency(CurrencyEnumeration value); + + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @return Currency of the price amount for an item. + */ + public CurrencyEnumeration getCurrency(); + + /** + * Homeowners association dues on the property. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
hoa_dues
Details Monthly dues paid to a homeowners association.
Example <g:hoa_dues>100</g:hoa_dues>
Attribute of Housing
Content type float
+ * @param hoaDues Homeowners association dues on the property. + */ + public void setHoaDues(Float hoaDues); + + /** + * Homeowners association dues on the property. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
hoa_dues
Details Monthly dues paid to a homeowners association.
Example <g:hoa_dues>100</g:hoa_dues>
Attribute of Housing
Content type float
+ * @return Homeowners association dues on the property. + */ + public Float getHoaDues(); + + /** + * Indicates whether this property is for sale or not. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
listing_type
Details Information about whether or not a property is + * for sale or not. Acceptable values are "True" or "False".
Example Acceptable:
+ * + * <g:for_sale>true</g:for_sale>
+ * <g:for_sale>false</g:for_sale>
+ * Not acceptable:
+ * + * <g:for_sale>Sale</g:for_sale>
+ * + * <g:for_sale>Rent</g:for_sale>
Attribute of Housing
Content type Boolean
+ * @param forSale Indicates whether this property is for sale or not. + */ + public void setListingType(Boolean forSale); + + /** + * Indicates whether this property is for sale or not. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
listing_type
Details Information about whether or not a property is + * for sale or not. Acceptable values are "True" or "False".
Example Acceptable:
+ * + * <g:for_sale>true</g:for_sale>
+ * <g:for_sale>false</g:for_sale>
+ * Not acceptable:
+ * + * <g:for_sale>Sale</g:for_sale>
+ * + * <g:for_sale>Rent</g:for_sale>
Attribute of Housing
Content type Boolean
+ * @return Indicates whether this property is for sale or not. + */ + public Boolean getListingType(); + + /** + * Location of the property. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @param location Location of the property. + */ + public void setLocation(String location); + + /** + * Location of the property. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @return Location of the property. + */ + public String getLocation(); + + /** + * Payment Methods acceptable for the property. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_accepted
+ * Details 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 + * <payment_accepted> attribute for each acceptable method.
+ * Example + * Acceptable:
+ * <g:payment_accepted>Cash</g:payment_accepted>
+ * + * <g:payment_accepted>Check</g:payment_accepted>
+ * + * <g:payment_accepted>Paypal</g:payment_accepted>
+ * Not acceptable:
+ * <g:payment_accepted>Cash + * Check Paypal</g:payment_accepted>
+ * Attribute of + * Events, Housing, + * Products, Services, Travel, Vehicles
+ * Content type + * paymentMethodEnumeration
+ * @param paymentAccepted Payment Methods acceptable for the property. + */ + public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted); + + /** + * Payment Methods acceptable for the property. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_accepted
+ * Details 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 + * <payment_accepted> attribute for each acceptable method.
+ * Example + * Acceptable:
+ * <g:payment_accepted>Cash</g:payment_accepted>
+ * + * <g:payment_accepted>Check</g:payment_accepted>
+ * + * <g:payment_accepted>Paypal</g:payment_accepted>
+ * Not acceptable:
+ * <g:payment_accepted>Cash + * Check Paypal</g:payment_accepted>
+ * Attribute of + * Events, Housing, + * Products, Services, Travel, Vehicles
+ * Content type + * paymentMethodEnumeration
+ * @return Payment Methods acceptable for the property. + */ + public PaymentTypeEnumeration[] getPaymentAccepted(); + + /** + * Additional payment information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * string
+ * @param paymentNotes Additional payment information. + */ + public void setPaymentNotes(String paymentNotes); + + /** + * Additional payment information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * string
+ * @return Additional payment information. + */ + public String getPaymentNotes(); + + /** + * Price for the property. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * price
+ * Details Prices can be a single price, 0 + * (free), or blank if not applicable. Numerice values only. When used + * as a sub-attribute of <shipping>, the value included reflects the price + * of shipping.
+ * Example + * Acceptable:
+ * <g:price>5.95</g:price>
+ * + * <g:price>0</g:price>
+ * Not acceptable:
+ * <g:price>5,95</g:price>
+ * <g:price>5.00 � 10.00</g:price>
+ * + * <g:price>100 or best offer</g:price>
+ * <g:price>free</g:price>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content typefloatUnit
+ * @param price Price for the property. + */ + public void setPrice(FloatUnit price); + + /** + * Price for the property. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * price
+ * Details Prices can be a single price, 0 + * (free), or blank if not applicable. Numerice values only. When used + * as a sub-attribute of <shipping>, the value included reflects the price + * of shipping.
+ * Example + * Acceptable:
+ * <g:price>5.95</g:price>
+ * + * <g:price>0</g:price>
+ * Not acceptable:
+ * <g:price>5,95</g:price>
+ * <g:price>5.00 � 10.00</g:price>
+ * + * <g:price>100 or best offer</g:price>
+ * <g:price>free</g:price>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content typefloatUnit
+ * @return Price for the property. + */ + public FloatUnit getPrice(); + + /** + * Price type information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
price_type
DetailsThe type of pricing for the + * item. Acceptable values are �negotiable,� or �starting.� The default is + * �starting�
ExampleAcceptable:
+ * <g:price_type>starting</g:price_type>
+ * Not acceptable:
+ * <g:price_type>100 OBO</g:price_type>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * priceTypeEnumeration
+ * @param priceType Price type information. + */ + public void setPriceType(PriceTypeEnumeration priceType); + + /** + * Price type information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
price_type
DetailsThe type of pricing for the + * item. Acceptable values are �negotiable,� or �starting.� The default is + * �starting�
ExampleAcceptable:
+ * <g:price_type>starting</g:price_type>
+ * Not acceptable:
+ * <g:price_type>100 OBO</g:price_type>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * priceTypeEnumeration
+ * @return Price type information. + */ + public PriceTypeEnumeration getPriceType(); + + /** + * Types of property represented here. Limit 10. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * property_type
+ * + * Details + * + * Type of property: house, apartment, condominium, + * etc.
+ * Example <g:property_type>house</g:property_type>
+ * Attribute of + * + * Housing
+ * Content type + * string
+ * @param propertyTypes Types of property represented here. Limit 10. + */ + public void setPropertyTypes(String[] propertyTypes); + + /** + * Types of property represented here. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * property_type
+ * + * Details + * + * Type of property: house, apartment, condominium, + * etc.
+ * Example <g:property_type>house</g:property_type>
+ * Attribute of + * + * Housing
+ * Content type + * string
+ * @return Types of property represented here. Limit 10. + */ + public String[] getPropertyTypes(); + + /** + * School district a property is in. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * school_district
+ * Details + * The school district the property is in.
+ * Example <g:school_district>Union School + * District</g:school_district>
+ * Attribute of + * Housing
+ * + * Content type + * string
+ * @param schoolDistrict School district a property is in. + */ + public void setSchoolDistrict(String schoolDistrict); + + /** + * School district a property is in. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * school_district
+ * Details + * The school district the property is in.
+ * Example <g:school_district>Union School + * District</g:school_district>
+ * Attribute of + * Housing
+ * + * Content type + * string
+ * @return School district a property is in. + */ + public String getSchoolDistrict(); + + /** + * Percentage tax rate. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * tax_percent
+ * + * Details + * Tax rate as a percentage.
+ * Example <g:tax_percent>8.2<g:/tax_percent>
+ * + * Attribute of + * + * Products, Events
+ * Content type + * percentType
+ * @param taxPercent Percentage tax rate. + */ + public void setTaxPercent(Float taxPercent); + + /** + * Percentage tax rate. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * tax_percent
+ * + * Details + * Tax rate as a percentage.
+ * Example <g:tax_percent>8.2<g:/tax_percent>
+ * + * Attribute of + * + * Products, Events
+ * Content type + * percentType
+ * @return Percentage tax rate. + */ + public Float getTaxPercent(); + + /** + * Geographical region a tax rate applies to. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * tax_region
+ * Details + * Geographical region a tax rate + * applies to.
+ * + * Example <g:tax_region>California</g:tax_region>
+ * Attribute of + * Product, + * Events,
+ * Content typestring
+ * @param taxRegion Geographical region a tax rate applies to. + */ + public void setTaxRegion(String taxRegion); + + /** + * Geographical region a tax rate applies to. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * tax_region
+ * Details + * Geographical region a tax rate + * applies to.
+ * + * Example <g:tax_region>California</g:tax_region>
+ * Attribute of + * Product, + * Events,
+ * Content typestring
+ * @return Geographical region a tax rate applies to. + */ + public String getTaxRegion(); + + /** + * The four digit model year or year built. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * year
+ * Details + * The four digit model year or year built. Format + * YYYY
+ * + * Example + * Acceptable:
+ * + * <g:year>2005</g:year>
+ * Not acceptable:
+ * <g:year>79</g:year>
+ * + * <g:year>26</g:year>
+ * Attribute of + * Housing, Vehicles
+ * + * Content type + * year
+ * @param year The four digit model year or year built. + */ + public void setYear(YearType year); + + /** + * The four digit model year or year built. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * year
+ * Details + * The four digit model year or year built. Format + * YYYY
+ * + * Example + * Acceptable:
+ * + * <g:year>2005</g:year>
+ * Not acceptable:
+ * <g:year>79</g:year>
+ * + * <g:year>26</g:year>
+ * Attribute of + * Housing, Vehicles
+ * + * Content type + * year
+ * @return The four digit model year or year built. + */ + public YearType getYear(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/Job.java b/src/main/java/com/sun/syndication/feed/module/base/Job.java new file mode 100644 index 0000000..0b471fb --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/Job.java @@ -0,0 +1,860 @@ +/* + * Job.java + * + * Created on November 16, 2005, 12:39 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.feed.module.base.types.CurrencyEnumeration; +import com.sun.syndication.feed.module.base.types.PriceTypeEnumeration; + + +/** This is an interface for the GoogleBase plug in that exposes methods used for + * Job listing entry types. + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public interface Job extends GlobalInterface { + /** + * Level of education required for an employment position. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
education
Details Level of education required for an employment + * position.
Example <g:education>PhD</g:education>
Attribute of Jobs
Content type string
+ * @param education Level of education required for an employment position. + */ + public void setEducation(String education); + + /** + * Level of education required for an employment position. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
education
Details Level of education required for an employment + * position.
Example <g:education>PhD</g:education>
Attribute of Jobs
Content type string
+ * @return Level of education required for an employment position. + */ + public String getEducation(); + + /** + * Company providing employment. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
employer
Details Company providing employment.
Example <g:employer>Google, Inc</g:employer>
Attribute of Jobs
Content type string
+ * @param employer Company providing employment. + */ + public void setEmployer(String employer); + + /** + * Company providing employment. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
employer
Details Company providing employment.
Example <g:employer>Google, Inc</g:employer>
Attribute of Jobs
Content type string
+ * @return Company providing employment. + */ + public String getEmployer(); + + /** + * Legal residency requirements for an employment position. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
immigration_status
Details Legal residency requirements for an employment + * position.
Example <g:immigration_status>Permanent resident</g:immigration_status>
Attribute of Jobs
Content type string
+ * @param immigrationStatus Legal residency requirements for an employment position. + */ + public void setImmigrationStatus(String immigrationStatus); + + /** + * Legal residency requirements for an employment position. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
immigration_status
Details Legal residency requirements for an employment + * position.
Example <g:immigration_status>Permanent resident</g:immigration_status>
Attribute of Jobs
Content type string
+ * @return Legal residency requirements for an employment position. + */ + public String getImmigrationStatus(); + + /** + * The functions of an employment position. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * job_function
+ * Details + * The function of an employment position.
+ * Example <g:job_function>Product + * Manager</g:job_function>
+ * + * Attribute of + * Jobs
+ * + * Content type + * string
+ * @param function The functions of an employment position. + */ + public void setJobFunctions(String[] function); + + /** + * The functions of an employment position. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * job_function
+ * Details + * The function of an employment position.
+ * Example <g:job_function>Product + * Manager</g:job_function>
+ * + * Attribute of + * Jobs
+ * + * Content type + * string
+ * @return The functions of an employment position. + */ + public String[] getJobFunctions(); + + /** + * The industry of an employment position. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * job_industry
+ * Details + * The industry of an employment position.
+ * Example <g:job_industry>Government</g:job_industry>
+ * Attribute of + * Jobs
+ * + * Content type + * string
+ * @param jobIndustries The industry of an employment position. + */ + public void setJobIndustries(String[] jobIndustries); + + /** + * The industry of an employment position. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * job_industry
+ * Details + * The industry of an employment position.
+ * Example <g:job_industry>Government</g:job_industry>
+ * Attribute of + * Jobs
+ * + * Content type + * string
+ * @return The industry of an employment position. + */ + public String[] getJobIndustries(); + + /** + * Type of employment position. Example: Full-time, part-time, contractor, etc. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * job_type
+ * Details + * Type of employment position. Example: Full-time, part-time, contractor, etc.
+ * Example <g:job_type>contractor</g:job_type>
+ * Attribute of + * Jobs
+ * + * Content type + * string
+ * @param jobTypes Type of employment position. Example: Full-time, part-time, contractor, etc. + */ + public void setJobTypes(String[] jobTypes); + + /** + * Type of employment position. Example: Full-time, part-time, contractor, etc. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * job_type
+ * Details + * Type of employment position. Example: Full-time, part-time, contractor, etc.
+ * Example <g:job_type>contractor</g:job_type>
+ * Attribute of + * Jobs
+ * + * Content type + * string
+ * @return Type of employment position. Example: Full-time, part-time, contractor, etc. + */ + public String[] getJobTypes(); + + /** + * Location of the position. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @param location Location of the position. + */ + public void setLocation(String location); + + /** + * Location of the position. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @return Location of the position. + */ + public String getLocation(); + + /** + * Salary for this position. Non-numeric values such as "$" symbols are not acceptable. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * salary
+ * Details + * Salary for this position. Non-numeric values such as "$" symbols are not acceptable.
+ * + * Example + * <g:salary>55000</g:salary>
+ * + * Attribute of + * Jobs
+ * Content type + * + * float
+ * @param salary Salary for this position. Non-numeric values such as "$" symbols are not acceptable. + */ + public void setSalary(Float salary); + + /** + * Salary for this position. Non-numeric values such as "$" symbols are not acceptable. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * salary
+ * Details + * Salary for this position. Non-numeric values such as "$" symbols are not acceptable.
+ * + * Example + * <g:salary>55000</g:salary>
+ * + * Attribute of + * Jobs
+ * Content type + * + * float
+ * @return Salary for this position. Non-numeric values such as "$" symbols are not acceptable. + */ + public Float getSalary(); + + /** + * The type of salary included. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * salary_type
+ * Details The type of salary included. + * Accepted values are �starting� or �negotiable;� The default is �starting + * at.�
+ * + * Example <g:salary_type>negotiable</g:salary_type>
+ * Attribute of + * Jobs
+ * + * Content type + * + * "starting" or "negotiable"
+ * @param salaryType The type of salary included. + */ + public void setSalaryType(PriceTypeEnumeration salaryType); + + /** + * The type of salary included. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * salary_type
+ * Details The type of salary included. + * Accepted values are �starting� or �negotiable;� The default is �starting + * at.�
+ * + * Example <g:salary_type>negotiable</g:salary_type>
+ * Attribute of + * Jobs
+ * + * Content type + * + * "starting" or "negotiable"
+ * @return The type of salary included. + */ + public PriceTypeEnumeration getSalaryType(); + + + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @param value Currency of the price amount for an item. + */ + public void setCurrency(CurrencyEnumeration value); + + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @return Currency of the price amount for an item. + */ + public CurrencyEnumeration getCurrency(); + +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/Person.java b/src/main/java/com/sun/syndication/feed/module/base/Person.java new file mode 100644 index 0000000..ae24a95 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/Person.java @@ -0,0 +1,830 @@ +/* + * Person.java + * + * Created on November 16, 2005, 1:26 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.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. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.2 $ + */ +public interface Person extends GlobalInterface { + /** + * Age of the individual. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
age
DetailsMinimum age requirement for the event or the age of the individual in a People profiles + * bulk upload entry.
ExampleAcceptable:
+ * < + * g:age>18</g:age>
+ * Not acceptable:
+ * + * < + * g:age>18 and over</g:age>
Attribute ofEvents, People profiles
Content typeinteger
+ * @param age Age of the individual. + */ + public void setAge(Integer age); + + /** + * Age of the individual. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
age
DetailsMinimum age requirement for the event or the age of the individual in a People profiles + * bulk upload entry.
ExampleAcceptable:
+ * < + * g:age>18</g:age>
+ * Not acceptable:
+ * + * < + * g:age>18 and over</g:age>
Attribute ofEvents, People profiles
Content typeinteger
+ * @return Age of the individual. + */ + public Integer getAge(); + + /** + * Education of the individual. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
education
Details Level of education required for an employment + * position.
Example <g:education>PhD</g:education>
Attribute of Jobs
Content type string
+ * @param education Education of the individual. + */ + public void setEducation(String education); + + /** + * Education of the individual. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
education
Details Level of education required for an employment + * position.
Example <g:education>PhD</g:education>
Attribute of Jobs
Content type string
+ * @return Education of the individual. + */ + public String getEducation(); + + /** + * Individuals employer. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
employer
Details Company providing employment.
Example <g:employer>Google, Inc</g:employer>
Attribute of Jobs
Content type string
+ * @param employer Individuals employer. + */ + public void setEmployer(String employer); + + /** + * Individuals employer. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
employer
Details Company providing employment.
Example <g:employer>Google, Inc</g:employer>
Attribute of Jobs
Content type string
+ * @return Individuals employer. + */ + public String getEmployer(); + + /** + * Ethnicity of the individual in the People profiles bulk upload entry. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
ethnicity
Details Ethnicity of the individual in the People profiles + * bulk upload entry.
Example <g:ethnicity>Latino</g:ethnicity>
Attribute of People profiles
Content type string
+ * @param ethnicities Ethnicity of the individual in the People profiles bulk upload entry. + */ + public void setEthnicities(String[] ethnicities); + + /** + * Ethnicity of the individual in the People profiles bulk upload entry. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
ethnicity
Details Ethnicity of the individual in the People profiles + * bulk upload entry.
Example <g:ethnicity>Latino</g:ethnicity>
Attribute of People profiles
Content type string
+ * @return Ethnicity of the individual in the People profiles bulk upload entry. + */ + public String[] getEthnicities(); + + /** + * Gender of an individual in a People profiles bulk upload. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
gender
Details Gender of an individual in a People profiles bulk upload + * item. Acceptable values are �Male�, �M�, + * �Female�, or �F�.
Example + * <gender>Female</gender>
Attribute of People profiles
Content type genderEnumeration
+ * @param gender Gender of an individual in a People profiles bulk upload. + */ + public void setGender(GenderEnumeration gender); + + /** + * Gender of an individual in a People profiles bulk upload. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
gender
Details Gender of an individual in a People profiles bulk upload + * item. Acceptable values are �Male�, �M�, + * �Female�, or �F�.
Example + * <gender>Female</gender>
Attribute of People profiles
Content type genderEnumeration
+ * @return Gender of an individual in a People profiles bulk upload. + */ + public GenderEnumeration getGender(); + + /** + * Interest of a person being profiled. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
interested_in
Details Interest of a person being profiled.
Example + * <g:interested_in>Long walks on the beach.</g:interested_in>
Attribute ofPeople profiles
Content type string
+ * @param interestedIn Interest of a person being profiled. + */ + public void setInterestedIn(String[] interestedIn); + + /** + * Interest of a person being profiled. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
interested_in
Details Interest of a person being profiled.
Example + * <g:interested_in>Long walks on the beach.</g:interested_in>
Attribute ofPeople profiles
Content type string
+ * @return Interest of a person being profiled. + */ + public String[] getInterestedIn(); + + /** + * Location of a person. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @param location Location of a person. + */ + public void setLocation(String location); + + /** + * Location of a person. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @return Location of a person. + */ + public String getLocation(); + + /** + * Marital status of an individual. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * marital_status
+ * + * Details Marital status of an individual + * in a People profiles bulk upload entry. + * For example -single, divorced, separated, widowed, married, and �in + * relationship.�
+ * Example + * <g:marital_status>single</g:marital_status>
+ * + *
+ * Attribute of + * People profiles
+ * + * Content type + * + * string
+ * @param maritalStatus Marital status of an individual. + */ + public void setMaritalStatus(String maritalStatus); + + /** + * Marital status of an individual. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * marital_status
+ * + * Details Marital status of an individual + * in a People profiles bulk upload entry. + * For example -single, divorced, separated, widowed, married, and �in + * relationship.�
+ * Example + * <g:marital_status>single</g:marital_status>
+ * + *
+ * Attribute of + * People profiles
+ * + * Content type + * + * string
+ * @return Marital status of an individual. + */ + public String getMaritalStatus(); + + /** + * Occupation of an individual. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * occupation
+ * + * Details + * Industry the individual in a People profiles bulk upload + * is employed in.
+ * Example <g:occupation>Sales</g:occupation>
+ * Attribute of + * + * People profiles
+ * + * Content type + * string
+ * @param occupation Occupation of an individual. + */ + public void setOccupation(String occupation); + + /** + * Occupation of an individual. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * occupation
+ * + * Details + * Industry the individual in a People profiles bulk upload + * is employed in.
+ * Example <g:occupation>Sales</g:occupation>
+ * Attribute of + * + * People profiles
+ * + * Content type + * string
+ * @return Occupation of an individual. + */ + public String getOccupation(); + + /** + * Individual's sexual orientation. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * sexual_orientation
+ * + * Details + * Sexual orientation of an individual in a People profiles information type..
+ * Example <g:sexual_orientation>straight</g:sexual_orientation>
+ * Attribute of + * + * Personal
+ * Content type + * string
+ * @param sexualOrientation Individual's sexual orientation. + */ + public void setSexualOrientation(String sexualOrientation); + + /** + * Individual's sexual orientation. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * sexual_orientation
+ * + * Details + * Sexual orientation of an individual in a People profiles information type..
+ * Example <g:sexual_orientation>straight</g:sexual_orientation>
+ * Attribute of + * + * Personal
+ * Content type + * string
+ * @return Individual's sexual orientation. + */ + public String getSexualOrientation(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/Product.java b/src/main/java/com/sun/syndication/feed/module/base/Product.java new file mode 100644 index 0000000..031d5a6 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/Product.java @@ -0,0 +1,2833 @@ +/* + * Product.java + * + * Created on November 16, 2005, 1:39 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.feed.module.base.types.CurrencyEnumeration; +import com.sun.syndication.feed.module.base.types.FloatUnit; +import com.sun.syndication.feed.module.base.types.PaymentTypeEnumeration; +import com.sun.syndication.feed.module.base.types.PriceTypeEnumeration; +import com.sun.syndication.feed.module.base.types.ShippingType; +import com.sun.syndication.feed.module.base.types.Size; + + +/** + * This is an interface for the GoogleBase plug in that exposes methods used for + * Products. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public interface Product extends GlobalInterface { + /** + * Actor featured in the video. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
actor
DetailsActor featured in the video.
Example<g:actor>Charlie Chaplin</g:actor>
Attribute ofProducts
Content typestring
+ * @param actors Actor featured in the video. + */ + public void setActors(String[] actors); + + /** + * Actor featured in the video. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
actor
DetailsActor featured in the video.
Example<g:actor>Charlie Chaplin</g:actor>
Attribute ofProducts
Content typestring
+ * @return Actor featured in the video. + */ + public String[] getActors(); + + /** + * The type of apparel being offered. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
apparel_type
Details The type of apparel being offered. Skirt, pants, sleepwear, etc.
Example<g:apparel_type>sweater</g:apparel_type>
Attribute ofProducts
Content typestring
+ * @param apparelType The type of apparel being offered. + */ + public void setApparelType(String apparelType); + + /** + * The type of apparel being offered. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
apparel_type
Details The type of apparel being offered. Skirt, pants, sleepwear, etc.
Example<g:apparel_type>sweater</g:apparel_type>
Attribute ofProducts
Content typestring
+ * @return The type of apparel being offered. + */ + public String getApparelType(); + + /** + * Artist that created the work. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * artist
+ * Details + * Artist that created the work.
+ * Example <g:artist>Vincent van Gogh</g:artist>
+ * Attribute of + * Products
+ * + * Content type + * string
+ * @param artists Artist that created the work. + */ + public void setArtists(String[] artists); + + /** + * Artist that created the work. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * artist
+ * Details + * Artist that created the work.
+ * Example <g:artist>Vincent van Gogh</g:artist>
+ * Attribute of + * Products
+ * + * Content type + * string
+ * @return Artist that created the work. + */ + public String[] getArtists(); + + /** + * Author of the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * author
+ * Details + * Author of the item.
+ * Example <g:author>John Steinbeck</g:author>
+ * Attribute of + * Reference Items, News and Articles
+ * Content type + * string
+ * @param authors Author of the item. + */ + public void setAuthors(String[] authors); + + /** + * Author of the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * author
+ * Details + * Author of the item.
+ * Example <g:author>John Steinbeck</g:author>
+ * Attribute of + * Reference Items, News and Articles
+ * Content type + * string
+ * @return Author of the item. + */ + public String[] getAuthors(); + + /** + * The brand name of an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
brand
Details The brand name of an item.
Example <g:brand>Acme</g:brand>
Attribute of Products
Content type string
+ * @param brand The brand name of an item. + */ + public void setBrand(String brand); + + /** + * The brand name of an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
brand
Details The brand name of an item.
Example <g:brand>Acme</g:brand>
Attribute of Products
Content type string
+ * @return The brand name of an item. + */ + public String getBrand(); + + /** + * Color of an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * color
+ * Details + * Color of an item.
+ * Example <g:color>Black</g:color>
+ * + * Attribute of + * Products, Vehicles
+ * Content type + * string
+ * @param color Color of an item. + */ + public void setColors(String[] color); + + /** + * Color of an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * color
+ * Details + * Color of an item.
+ * Example <g:color>Black</g:color>
+ * + * Attribute of + * Products, Vehicles
+ * Content type + * string
+ * @return Color of an item. + */ + public String[] getColors(); + + /** + * Condition of the item. For example: new, used, or refurbished. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
condition
Details Condition + * of the item. For example: new, used, or refurbished.
Example + * <g:condition>refurbished</g:condition>
Attribute + * of Products, + * Vehicles
Content + * type string
+ * @param condition Condition of the item. For example: new, used, or refurbished. + */ + public void setCondition(String condition); + + /** + * Condition of the item. For example: new, used, or refurbished. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
condition
Details Condition + * of the item. For example: new, used, or refurbished.
Example + * <g:condition>refurbished</g:condition>
Attribute + * of Products, + * Vehicles
Content + * type string
+ * @return Condition of the item. For example: new, used, or refurbished. + */ + public String getCondition(); + + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @param value Currency of the price amount for an item. + */ + public void setCurrency(CurrencyEnumeration value); + + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @return Currency of the price amount for an item. + */ + public CurrencyEnumeration getCurrency(); + + /** + * Additional instructions to explain the item’s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @param deliveryNotes Additional instructions to explain the item’s delivery process. + */ + public void setDeliveryNotes(String deliveryNotes); + + /** + * Additional instructions to explain the item;s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item�s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @return Additional instructions to explain the item�s delivery process. + */ + public String getDeliveryNotes(); + + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @param deliveryRadius The maximum distance you will deliver an item in any direction. + */ + public void setDeliveryRadius(FloatUnit deliveryRadius); + + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @return The maximum distance you will deliver an item in any direction. + */ + public FloatUnit getDeliveryRadius(); + + /** + * Format of the content. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
format
Details Format of the content.
Example <g:format>DVD</g:format>
+ * + * <g:format>CD</g:format>
Attribute of Products
Content type string
+ * @param format Format of the content. + */ + public void setFormat(String[] format); + + /** + * Format of the content. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
format
Details Format of the content.
Example <g:format>DVD</g:format>
+ * + * <g:format>CD</g:format>
Attribute of Products
Content type string
+ * @return Format of the content. + */ + public String[] getFormat(); + + /** + * A unique 10 or 13 digit number assigned to every printed book. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
isbn
DetailsA unique 10 or 13 digit number assigned to every printed + * book.
Example<g:isbn>0451524233</g:isbn>
Attribute ofProducts
Content typestring
+ * @param isbn A unique 10 or 13 digit number assigned to every printed book. + */ + public void setIsbn(String isbn); + + /** + * A unique 10 or 13 digit number assigned to every printed book. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
isbn
DetailsA unique 10 or 13 digit number assigned to every printed + * book.
Example<g:isbn>0451524233</g:isbn>
Attribute ofProducts
Content typestring
+ * @return A unique 10 or 13 digit number assigned to every printed book. + */ + public String getIsbn(); + + /** + * Location of a property. Should include street, city, state, postal code, and country, in that order. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @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
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @return Location of a property. Should include street, city, state, postal code, and country, in that order. + */ + public String getLocation(); + + /** + * Company that manufactures the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * manufacturer
+ * Details + * + * Company that manufactures the + * item.
+ * Example + * <g:manufacturer>Acme, Inc</g:manufacturer>
+ * Attribute of + * Products
+ * + * Content type + * string
+ * @param manufacturer Company that manufactures the item. + */ + public void setManufacturer(String manufacturer); + + /** + * Company that manufactures the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * manufacturer
+ * Details + * + * Company that manufactures the + * item.
+ * Example + * <g:manufacturer>Acme, Inc</g:manufacturer>
+ * Attribute of + * Products
+ * + * Content type + * string
+ * @return Company that manufactures the item. + */ + public String getManufacturer(); + + /** + * Unique product ID code assigned by its manufacturer. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * manufacturer_id
+ * Details + * + * Unique product ID code assigned by its + * manufacturer.
+ * Example <g:manufacturer_id>030779A</g:manufacturer_id>
+ * Attribute of + * Products
+ * Content type + * string
+ * @param manufacturerId Unique product ID code assigned by its manufacturer. + */ + public void setManufacturerId(String manufacturerId); + + /** + * Unique product ID code assigned by its manufacturer. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * manufacturer_id
+ * Details + * + * Unique product ID code assigned by its + * manufacturer.
+ * Example <g:manufacturer_id>030779A</g:manufacturer_id>
+ * Attribute of + * Products
+ * Content type + * string
+ * @return Unique product ID code assigned by its manufacturer. + */ + public String getManufacturerId(); + + /** + * Resolution of a digital imaging device. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * megapixels
+ * Details + * Resolution of a digital imaging device.
+ * Example <g:megapixels>5.2 MP</g:megapixels>
+ * Attribute of + * Products
+ * + * Content type + * floatUnit
+ * @param megapixels Resolution of a digital imaging device. + */ + public void setMegapixels(FloatUnit megapixels); + + /** + * Resolution of a digital imaging device. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * megapixels
+ * Details + * Resolution of a digital imaging device.
+ * Example <g:megapixels>5.2 MP</g:megapixels>
+ * Attribute of + * Products
+ * + * Content type + * floatUnit
+ * @return Resolution of a digital imaging device. + */ + public FloatUnit getMegapixels(); + + /** + * The amount of memory included in an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * memory
+ * Details + * The amount of memory included in an + * item.
+ * Example <g:memory>128 MB</g:memory>
+ * + * Attribute of + * Products
+ * + * Content type + * floatUnit
+ * @param memory The amount of memory included in an item. + */ + public void setMemory(FloatUnit memory); + + /** + * The amount of memory included in an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * memory
+ * Details + * The amount of memory included in an + * item.
+ * Example <g:memory>128 MB</g:memory>
+ * + * Attribute of + * Products
+ * + * Content type + * floatUnit
+ * @return The amount of memory included in an item. + */ + public FloatUnit getMemory(); + + /** + * Model number of the product. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * model_number
+ * Details + * + * Model number of the product.
+ * Example <g:model_number>1924863</g:model_number>
+ * Attribute of + * Products
+ * Content type + * string
+ * @param modelNumber Model number of the product. + */ + public void setModelNumber(String modelNumber); + + /** + * Model number of the product. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * model_number
+ * Details + * + * Model number of the product.
+ * Example <g:model_number>1924863</g:model_number>
+ * Attribute of + * Products
+ * Content type + * string
+ * @return Model number of the product. + */ + public String getModelNumber(); + + /** + * Acceptable payment methods for item purchases. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_accepted
+ * Details 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 + * <payment_accepted> attribute + * for each acceptable method.
+ * Example + * Acceptable:
+ * <g:payment_accepted>Cash</g:payment_accepted>
+ * + * <g:payment_accepted>Check</g:payment_accepted>
+ * Not acceptable:
+ * <g:payment_accepted>Cash + * Check</g:payment_accepted>
+ * Attribute of + * Events, Housing, + * Products, Services, Travel, Vehicles
+ * Content type + * + * paymentMethodEnumeration
+ * @param paymentAccepted Acceptable payment methods for item purchases. + */ + public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted); + + /** + * Acceptable payment methods for item purchases. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_accepted
+ * Details 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 + * <payment_accepted> attribute + * for each acceptable method.
+ * Example + * Acceptable:
+ * <g:payment_accepted>Cash</g:payment_accepted>
+ * + * <g:payment_accepted>Check</g:payment_accepted>
+ * Not acceptable:
+ * <g:payment_accepted>Cash + * Check</g:payment_accepted>
+ * Attribute of + * Events, Housing, + * Products, Services, Travel, Vehicles
+ * Content type + * + * paymentMethodEnumeration
+ * @return Acceptable payment methods for item purchases. + */ + public PaymentTypeEnumeration[] getPaymentAccepted(); + + /** + * Additional instructions to explain a payment policy. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * + * Content type + * string
+ * @param paymentNotes Additional instructions to explain a payment policy. + */ + public void setPaymentNotes(String paymentNotes); + + /** + * Additional instructions to explain a payment policy. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * + * Content type + * string
+ * @return Additional instructions to explain a payment policy. + */ + public String getPaymentNotes(); + + /** + * Whether or not an item is available for pick up. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * pickup
+ * Details + * Information about whether or not + * an item is available for pick up. Acceptable values are "True and "False".
+ * Example + * + * Acceptable:
+ * <g:pickup>True</g:pickup>
+ * Not acceptable:
+ * <g:pickup>Not + * on Tuesdays</g:pickup>
+ * Attribute of + * Products
+ * + * Content type + * boolean
+ * @param pickup Whether or not an item is available for pick up. + */ + public void setPickup(Boolean pickup); + + /** + * Whether or not an item is available for pick up. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * pickup
+ * Details + * Information about whether or not + * an item is available for pick up. Acceptable values are "True and "False".
+ * Example + * + * Acceptable:
+ * <g:pickup>True</g:pickup>
+ * Not acceptable:
+ * <g:pickup>Not + * on Tuesdays</g:pickup>
+ * Attribute of + * Products
+ * + * Content type + * boolean
+ * @return Whether or not an item is available for pick up. + */ + public Boolean getPickup(); + + /** + * Price of the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * price
+ * Details Prices can be a single price, 0 + * (free), or blank if not applicable. Numerice values only. When used + * as a sub-attribute of <shipping>, the value included reflects the price + * of shipping.
+ * Example + * Acceptable:
+ * <g:price>5.95</g:price>
+ * + * <g:price>0</g:price>
+ * Not acceptable:
+ * <g:price>5,95</g:price>
+ * <g:price>5.00 – 10.00</g:price>
+ * + * <g:price>100 or best offer</g:price>
+ * <g:price>free</g:price>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content typefloatUnit
+ * @param price Price of the item. + */ + public void setPrice(FloatUnit price); + + /** + * Price of the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * price
+ * Details Prices can be a single price, 0 + * (free), or blank if not applicable. Numerice values only. When used + * as a sub-attribute of <shipping>, the value included reflects the price + * of shipping.
+ * Example + * Acceptable:
+ * <g:price>5.95</g:price>
+ * + * <g:price>0</g:price>
+ * Not acceptable:
+ * <g:price>5,95</g:price>
+ * <g:price>5.00 – 10.00</g:price>
+ * + * <g:price>100 or best offer</g:price>
+ * <g:price>free</g:price>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content typefloatUnit
+ * @return Price of the item. + */ + public FloatUnit getPrice(); + + /** + * The type of pricing for the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
price_type
DetailsThe type of pricing for the + * item. Acceptable values are “negotiable,” or “starting.” The default is + * “starting”
ExampleAcceptable:
+ * <g:price_type>starting</g:price_type>
+ * Not acceptable:
+ * <g:price_type>100 OBO</g:price_type>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * priceTypeEnumeration
+ * @param priceType The type of pricing for the item. + */ + public void setPriceType(PriceTypeEnumeration priceType); + + /** + * The type of pricing for the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
price_type
DetailsThe type of pricing for the + * item. Acceptable values are “negotiable,” or “starting.” The default is + * “starting”
ExampleAcceptable:
+ * <g:price_type>starting</g:price_type>
+ * Not acceptable:
+ * <g:price_type>100 OBO</g:price_type>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * priceTypeEnumeration
+ * @return The type of pricing for the item. + */ + public PriceTypeEnumeration getPriceType(); + + /** + * The processor speed for the product. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * processor_speed
+ * Details + * The processor speed for the + * product.
+ * Example <g:processor_speed>2</g:processor_speed>
+ * Attribute of + * Products
+ * Content type + * floatUnit
+ * @param processorSpeed The processor speed for the product. + */ + public void setProcessorSpeed(FloatUnit processorSpeed); + + /** + * The processor speed for the product. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * processor_speed
+ * Details + * The processor speed for the + * product.
+ * Example <g:processor_speed>2</g:processor_speed>
+ * Attribute of + * Products
+ * Content type + * floatUnit
+ * @return The processor speed for the product. + */ + public FloatUnit getProcessorSpeed(); + + /** + * The type of product being offered. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * product_type
+ * Details + * + * The type of product being offered. Toys, books, + * flowers, etc.
+ * Example <g:product_type>electronics</g:product_type>
+ * Attribute of + * Products
+ * Content type + * string
+ * @param productTypes The type of product being offered. + */ + public void setProductTypes(String[] productTypes); + + /** + * The type of product being offered. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * product_type
+ * Details + * + * The type of product being offered. Toys, books, + * flowers, etc.
+ * Example <g:product_type>electronics</g:product_type>
+ * Attribute of + * Products
+ * Content type + * string
+ * @return The type of product being offered. + */ + public String[] getProductTypes(); + + /** + * Quantity available. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * quantity
+ * Details 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.
+ * Example + * Acceptable:
+ * <g:quantity>18</g:quantity>
+ * + * <g:quantity>0</g:quantity>
+ * + * Not acceptable:
+ * <g:quantity>out + * of stock</g:quantity>
+ * + * Attribute of + * Events, Products, + * Services, Travel, Vehicles
+ * Content type + * + * integer
+ * @param quantity Quantity available. + */ + public void setQuantity(Integer quantity); + + /** + * Quantity available. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * quantity
+ * Details 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.
+ * Example + * Acceptable:
+ * <g:quantity>18</g:quantity>
+ * + * <g:quantity>0</g:quantity>
+ * + * Not acceptable:
+ * <g:quantity>out + * of stock</g:quantity>
+ * + * Attribute of + * Events, Products, + * Services, Travel, Vehicles
+ * Content type + * + * integer
+ * @return Quantity available. + */ + public Integer getQuantity(); + + /** + * Shipping options available for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * shipping
+ * Details + * 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:
    + * + *
  • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
    • + *
  • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
    • + *
  • price = + * the price of shipping.
+ * + * Example <g:shipping>
+ * <g:country>US</g:country>
+ * + * <g:service>UPS</g:shipping>
+ * + * <g:price>35.95</g:price>
+ * </g:shipping>
+ * Attribute of + * Products
+ * + * Content type + * shippingType
+ * @param shipping Shipping options available for an item. + */ + public void setShipping(ShippingType[] shipping); + + /** + * Shipping options available for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * shipping
+ * Details + * 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:
    + * + *
  • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
    • + *
  • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
    • + *
  • price = + * the price of shipping.
+ * + * Example <g:shipping>
+ * <g:country>US</g:country>
+ * + * <g:service>UPS</g:shipping>
+ * + * <g:price>35.95</g:price>
+ * </g:shipping>
+ * Attribute of + * Products
+ * + * Content type + * shippingType
+ * @return Shipping options available for an item. + */ + public ShippingType[] getShipping(); + + /** + * Dimensions of the item, expressed in either two or three dimensions. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * size
+ * Details + * Dimensions of the item, expressed + * in either two or three dimensions.
+ * Example <g:size>12x10x4</g:size>
+ * + * Attribute of + * Products
+ * Content type + * string
+ * @param size Dimensions of the item, expressed in either two or three dimensions. + */ + public void setSize(Size size); + + /** + * Dimensions of the item, expressed in either two or three dimensions. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * size
+ * Details + * Dimensions of the item, expressed + * in either two or three dimensions.
+ * Example <g:size>12x10x4</g:size>
+ * + * Attribute of + * Products
+ * Content type + * string
+ * @return Dimensions of the item, expressed in either two or three dimensions. + */ + public Size getSize(); + + /** + * Tax rate associated with the event. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * tax_percent
+ * + * Details + * Tax rate as a percentage.
+ * Example <g:tax_percent>8.2<g:/tax_percent>
+ * + * Attribute of + * + * Products, Events
+ * Content type + * percentType
+ * @param taxPercent Tax rate associated with the event. + */ + public void setTaxPercent(Float taxPercent); + + /** + * Tax rate associated with the event. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * tax_percent
+ * + * Details + * Tax rate as a percentage.
+ * Example <g:tax_percent>8.2<g:/tax_percent>
+ * + * Attribute of + * + * Products, Events
+ * Content type + * percentType
+ * @return Tax rate associated with the event. + */ + public Float getTaxPercent(); + + /** + * Region where tax applies. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * tax_region
+ * Details + * Geographical region a tax rate + * applies to.
+ * + * Example <g:tax_region>California</g:tax_region>
+ * Attribute of + * Product, + * Events,
+ * Content typestring
+ * @param taxRegion Region where tax applies. + */ + public void setTaxRegion(String taxRegion); + + /** + * Region where tax applies. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * tax_region
+ * Details + * Geographical region a tax rate + * applies to.
+ * + * Example <g:tax_region>California</g:tax_region>
+ * Attribute of + * Product, + * Events,
+ * Content typestring
+ * @return Region where tax applies. + */ + public String getTaxRegion(); + + /** + * Product UPC code (Isn't that redundant?). + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * upc
+ * Details + * Product UPC code.
+ * Example <g:upc>834721479305</g:upc>
+ * Attribute of + * Products
+ * + * Content type + * string
+ * @param upc Product UPC code (Isn't that redundant?). + */ + public void setUpc(String upc); + + /** + * Product UPC code (Isn't that redundant?). + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * upc
+ * Details + * Product UPC code.
+ * Example <g:upc>834721479305</g:upc>
+ * Attribute of + * Products
+ * + * Content type + * string
+ * @return Product UPC code (Isn't that redundant?). + */ + public String getUpc(); + + /** + * Weight of the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * weight
+ * Details + * Weight of the item.
+ * Example <g:weight>5</g:weight>
+ * Attribute of + * Products
+ * + * Content type + * floatUnit
+ * @param weight Weight of the item. + */ + public void setWeight(FloatUnit weight); + + /** + * Weight of the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * weight
+ * Details + * Weight of the item.
+ * Example <g:weight>5</g:weight>
+ * Attribute of + * Products
+ * + * Content type + * floatUnit
+ * @return Weight of the item. + */ + public FloatUnit getWeight(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/Review.java b/src/main/java/com/sun/syndication/feed/module/base/Review.java new file mode 100644 index 0000000..21526c2 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/Review.java @@ -0,0 +1,836 @@ +/* + * Review.java + * + * Created on November 16, 2005, 1:58 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.feed.module.base.types.FloatUnit; +import java.net.URL; + +import java.util.Date; + + +/** + * This is an interface for the GoogleBase plug in that exposes methods used for + * critical reviews of other things. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public interface Review extends GlobalInterface { + /** + * Author of the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * author
+ * Details + * Author of the item.
+ * Example <g:author>John Steinbeck</g:author>
+ * Attribute of + * Reference Items, News and Articles
+ * Content type + * string
+ * @param authors Author of the item. + */ + public void setAuthors(String[] authors); + + /** + * Author of the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * author
+ * Details + * Author of the item.
+ * Example <g:author>John Steinbeck</g:author>
+ * Attribute of + * Reference Items, News and Articles
+ * Content type + * string
+ * @return Author of the item. + */ + public String[] getAuthors(); + + /** + * Additional instructions to explain the item’s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @param deliveryNotes Additional instructions to explain the item’s delivery process. + */ + public void setDeliveryNotes(String deliveryNotes); + + /** + * Additional instructions to explain the item’s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @return Additional instructions to explain the item’s delivery process. + */ + public String getDeliveryNotes(); + + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @param deliveryRadius The maximum distance you will deliver an item in any direction. + */ + public void setDeliveryRadius(FloatUnit deliveryRadius); + + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @return The maximum distance you will deliver an item in any direction. + */ + public FloatUnit getDeliveryRadius(); + + /** + * The name of an item being reviewed. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * name_of_item_being_reviewed
+ * Details + * + * The name of an item being reviewed.
+ * Example <g:name_of_item_being__reviewed>Fleur de lys Restaurant</g:name_of_item_being_reviewed>
+ * Attribute of + * Reviews
+ * Content type + * string
+ * @param nameOfItemBeingReviewed The name of an item being reviewed. + */ + public void setNameOfItemBeingReviewed(String nameOfItemBeingReviewed); + + /** + * The name of an item being reviewed. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * name_of_item_being_reviewed
+ * Details + * + * The name of an item being reviewed.
+ * Example <g:name_of_item_being__reviewed>Fleur de lys Restaurant</g:name_of_item_being_reviewed>
+ * Attribute of + * Reviews
+ * Content type + * string
+ * @return The name of an item being reviewed. + */ + public String getNameOfItemBeingReviewed(); + + /** + * Date the item was published. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * publish_date
+ * Details + * Date the item was published in ISO 8601 format: + * YYYY-MM-DD
+ * Example <g:publish_date>2005-12-20</g:publish_date>
+ * Attribute of + * + * Reference Items
+ * + * Content type + * date
+ * @param publishDate Date the item was published. + */ + public void setPublishDate(Date publishDate); + + /** + * Date the item was published. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * publish_date
+ * Details + * Date the item was published in ISO 8601 format: + * YYYY-MM-DD
+ * Example <g:publish_date>2005-12-20</g:publish_date>
+ * Attribute of + * + * Reference Items
+ * + * Content type + * date
+ * @return Date the item was published. + */ + public Date getPublishDate(); + + /** + * Rating of the product or service on a scale of 1-5, with 5 as the best. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * rating
+ * Details + * Rating of the product or service + * on a scale of 1-5, with 5 as the best. Numeric values only.
+ * Example + * Acceptable:
+ * <g:rating>4</g:rating>
+ * + * Not acceptable:
+ * + * <g:rating>good</g:rating>
+ * Attribute of + * Reviews
+ * Content type + * + * string
+ * @param rating Rating of the product or service on a scale of 1-5, with 5 as the best. + */ + public void setRating(Float rating); + + /** + * Rating of the product or service on a scale of 1-5, with 5 as the best. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * rating
+ * Details + * Rating of the product or service + * on a scale of 1-5, with 5 as the best. Numeric values only.
+ * Example + * Acceptable:
+ * <g:rating>4</g:rating>
+ * + * Not acceptable:
+ * + * <g:rating>good</g:rating>
+ * Attribute of + * Reviews
+ * Content type + * + * string
+ * @return Rating of the product or service on a scale of 1-5, with 5 as the best. + */ + public Float getRating(); + + /** + * The category of the item being reviewed. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * review_type
+ * + * Details The category of the item being reviewed.
+ * Example + * <g:review_type>toy</g:review_type>
+ * + * <g:review_type>music</g:review_type>
+ * <g:review_type>restaraunt</g:review_type>
+ * Attribute of + * Reviews
+ * Content type + * string
+ * @param reviewType The category of the item being reviewed. + */ + public void setReviewType(String reviewType); + + /** + * The category of the item being reviewed. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * review_type
+ * + * Details The category of the item being reviewed.
+ * Example + * <g:review_type>toy</g:review_type>
+ * + * <g:review_type>music</g:review_type>
+ * <g:review_type>restaraunt</g:review_type>
+ * Attribute of + * Reviews
+ * Content type + * string
+ * @return The category of the item being reviewed. + */ + 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). + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * reviewer_type
+ * Details 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)
+ * + * Example + * <g:reviewer_type>editorial</g:reviewer_type>
+ * Attribute of + * Reviews
+ * Content type + * string
+ * @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). + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * reviewer_type
+ * Details 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)
+ * + * Example + * <g:reviewer_type>editorial</g:reviewer_type>
+ * Attribute of + * Reviews
+ * Content type + * string
+ * @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(); + + /** + * The web page of an item being reviewed. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * url_of_item_being_reviewed
+ * + * Details + * The web page of an item being reviewed.
+ * Example <g:url_of_item_being_reviewed>http://www.fleurdelyssf.com/</g:url_of_item_being_reviewed>
+ * Attribute of + * + * Reviews
+ * + * Content type + * uri
+ * @param urlOfItemBeingReviewed The web page of an item being reviewed. + */ + public void setUrlOfItemBeingReviewed(URL urlOfItemBeingReviewed); + + /** + * The web page of an item being reviewed. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * url_of_item_being_reviewed
+ * + * Details + * The web page of an item being reviewed.
+ * Example <g:url_of_item_being_reviewed>http://www.fleurdelyssf.com/</g:url_of_item_being_reviewed>
+ * Attribute of + * + * Reviews
+ * + * Content type + * uri
+ * @return The web page of an item being reviewed. + */ + public URL getUrlOfItemBeingReviewed(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/ScholarlyArticle.java b/src/main/java/com/sun/syndication/feed/module/base/ScholarlyArticle.java new file mode 100644 index 0000000..0263316 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/ScholarlyArticle.java @@ -0,0 +1,482 @@ +/* + * ScholarlyArticle.java + * + * Created on November 16, 2005, 1:55 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.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. + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.2 $ + */ +public interface ScholarlyArticle extends GlobalInterface { + /** + * Array of Author Names. Limit 10. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * author
+ * Details + * Author of the item.
+ * Example <g:author>John Steinbeck</g:author>
+ * Attribute of + * Reference Items, News and Articles
+ * Content type + * string
+ * @param authors Array of Author Names. Limit 10. + */ + public void setAuthors(String[] authors); + + /** + * Array of Author Names. Limit 10. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * author
+ * Details + * Author of the item.
+ * Example <g:author>John Steinbeck</g:author>
+ * Attribute of + * Reference Items, News and Articles
+ * Content type + * string
+ * @return Array of author names. + */ + public String[] getAuthors(); + + /** + * Number of pages in the article. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * pages
+ * Details + * + * The number of pages in the publication.
+ * Example <g:pages>18</g:pages>
+ * Attribute of + * Reference Items, News and Articles
+ * + * Content type + * integer
+ * @param pages Number of pages in the article + */ + public void setPages(Integer pages); + + /** + * Number of pages in the article. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * pages
+ * Details + * + * The number of pages in the publication.
+ * Example <g:pages>18</g:pages>
+ * Attribute of + * Reference Items, News and Articles
+ * + * Content type + * integer
+ * @return Number of pages in the article + */ + public Integer getPages(); + + /** + * Name of the publication. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * publication_name
+ * Details + * + * Name of the publication.
+ * Example <g:publication_name> Journal of Appropriate Technology</g:publication_name>
+ * Attribute of + * Research studies and publications
+ * + * Content type + * string
+ * @param publicationName Name of the publication. + */ + public void setPublicationName(String publicationName); + + /** + * Name of the publication. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * publication_name
+ * Details + * + * Name of the publication.
+ * Example <g:publication_name> Journal of Appropriate Technology</g:publication_name>
+ * Attribute of + * Research studies and publications
+ * + * Content type + * string
+ * @return Name of the publication. + */ + public String getPublicationName(); + + /** + * Volume of the publication. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * publication_volume
+ * Details + * + * Volume of the publication.
+ * Example<g:publication_volume>VI</g:publication_volume>
+ * Attribute of + * Reference Items
+ * Content type + * string
+ * @param publicationVolume Volume of the publication. + */ + public void setPublicationVolume(String publicationVolume); + + /** + * Volume of the publication. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * publication_volume
+ * Details + * + * Volume of the publication.
+ * Example<g:publication_volume>VI</g:publication_volume>
+ * Attribute of + * Reference Items
+ * Content type + * string
+ * @return Volume of the publication. + */ + public String getPublicationVolume(); + + /** + * Date article was published. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * publish_date
+ * + * Details + * Date the item was published in ISO 8601 format: + * YYYY-MM-DD
+ * + * Example <g:publish_date>2005-12-20</g:publish_date>
+ * Attribute of + * Reference Items
+ * + * Content type + * + * date
+ * @param publishDate Date article was published + */ + public void setPublishDate(Date publishDate); + + /** + * Date article was published. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * publish_date
+ * + * Details + * Date the item was published in ISO 8601 format: + * YYYY-MM-DD
+ * + * Example <g:publish_date>2005-12-20</g:publish_date>
+ * Attribute of + * Reference Items
+ * + * Content type + * + * date
+ * @return Date article was published + */ + public Date getPublishDate(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/Service.java b/src/main/java/com/sun/syndication/feed/module/base/Service.java new file mode 100644 index 0000000..41dca35 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/Service.java @@ -0,0 +1,1286 @@ +/* + * Service.java + * + * Created on November 16, 2005, 2:14 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * ee the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.feed.module.base.types.CurrencyEnumeration; +import com.sun.syndication.feed.module.base.types.FloatUnit; +import com.sun.syndication.feed.module.base.types.PaymentTypeEnumeration; +import com.sun.syndication.feed.module.base.types.PriceTypeEnumeration; +import com.sun.syndication.feed.module.base.types.ShippingType; + + +/** + * This is an interface for the GoogleBase plug in that exposes methods used for + * service offerings. + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public interface Service extends GlobalInterface { + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @param value Currency of the price amount for an item. + */ + public void setCurrency(CurrencyEnumeration value); + + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @return Currency of the price amount for an item. + */ + public CurrencyEnumeration getCurrency(); + + /** + * Additional instructions to explain the item’s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @param deliveryNotes Additional instructions to explain the item’s delivery process. + */ + public void setDeliveryNotes(String deliveryNotes); + + + /** + * Additional instructions to explain the item’s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @return Additional instructions to explain the item’s delivery process. + */ + public String getDeliveryNotes(); + + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @param deliveryRadius The maximum distance you will deliver an item in any direction. + */ + public void setDeliveryRadius(FloatUnit deliveryRadius); + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @return The maximum distance you will deliver an item in any direction. + */ + public FloatUnit getDeliveryRadius(); + + /** + * Location of the where the service is offered. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @param location Location of the where the service is offered. + */ + public void setLocation(String location); + + /** + * Location of the where the service is offered. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @return Location of the where the service is offered. + */ + public String getLocation(); + + /** + * Payment Methods acceptable for the service. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_accepted
+ * Details 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 + * <payment_accepted> attribute for each acceptable method.
+ * Example + * Acceptable:
+ * <g:payment_accepted>Cash</g:payment_accepted>
+ * + * <g:payment_accepted>Check</g:payment_accepted>
+ * + * <g:payment_accepted>Paypal</g:payment_accepted>
+ * Not acceptable:
+ * <g:payment_accepted>Cash + * Check Paypal</g:payment_accepted>
+ * Attribute of + * Events, Housing, + * Products, Services, Travel, Vehicles
+ * Content type + * paymentMethodEnumeration
+ * @param paymentAccepted Payment Methods acceptable for the service. + */ + public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted); + + /** + * Payment Methods acceptable for the service. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_accepted
+ * Details 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 + * <payment_accepted> attribute for each acceptable method.
+ * Example + * Acceptable:
+ * <g:payment_accepted>Cash</g:payment_accepted>
+ * + * <g:payment_accepted>Check</g:payment_accepted>
+ * + * <g:payment_accepted>Paypal</g:payment_accepted>
+ * Not acceptable:
+ * <g:payment_accepted>Cash + * Check Paypal</g:payment_accepted>
+ * Attribute of + * Events, Housing, + * Products, Services, Travel, Vehicles
+ * Content type + * paymentMethodEnumeration
+ * @return Payment Methods acceptable for the service. + */ + public PaymentTypeEnumeration[] getPaymentAccepted(); + + /** + * Additional payment information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * string
+ * @param paymentNotes Additional payment information. + */ + public void setPaymentNotes(String paymentNotes); + + /** + * Additional payment information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * string
+ * @return Additional payment information. + */ + public String getPaymentNotes(); + + /** + * Price for the service. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * price
+ * Details Prices can be a single price, 0 + * (free), or blank if not applicable. Numerice values only. When used + * as a sub-attribute of <shipping>, the value included reflects the price + * of shipping.
+ * Example + * Acceptable:
+ * <g:price>5.95</g:price>
+ * + * <g:price>0</g:price>
+ * Not acceptable:
+ * <g:price>5,95</g:price>
+ * <g:price>5.00 � 10.00</g:price>
+ * + * <g:price>100 or best offer</g:price>
+ * <g:price>free</g:price>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content typefloatUnit
+ * @param price Price for the service. + */ + public void setPrice(FloatUnit price); + + /** + * Price for the service. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * price
+ * Details Prices can be a single price, 0 + * (free), or blank if not applicable. Numerice values only. When used + * as a sub-attribute of <shipping>, the value included reflects the price + * of shipping.
+ * Example + * Acceptable:
+ * <g:price>5.95</g:price>
+ * + * <g:price>0</g:price>
+ * Not acceptable:
+ * <g:price>5,95</g:price>
+ * <g:price>5.00 � 10.00</g:price>
+ * + * <g:price>100 or best offer</g:price>
+ * <g:price>free</g:price>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content typefloatUnit
+ * @return Price for the service. + */ + public FloatUnit getPrice(); + + /** + * Price type information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
price_type
DetailsThe type of pricing for the + * item. Acceptable values are �negotiable,� or �starting.� The default is + * �starting�
ExampleAcceptable:
+ * <g:price_type>starting</g:price_type>
+ * Not acceptable:
+ * <g:price_type>100 OBO</g:price_type>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * priceTypeEnumeration
+ * @param priceType Price type information. + */ + public void setPriceType(PriceTypeEnumeration priceType); + + /** + * Price type information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
price_type
DetailsThe type of pricing for the + * item. Acceptable values are �negotiable,� or �starting.� The default is + * �starting�
ExampleAcceptable:
+ * <g:price_type>starting</g:price_type>
+ * Not acceptable:
+ * <g:price_type>100 OBO</g:price_type>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * priceTypeEnumeration
+ * @return Price type information. + */ + public PriceTypeEnumeration getPriceType(); + + /** + * Quantity available. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * quantity
+ * Details 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.
+ * Example + * Acceptable:
+ * <g:quantity>18</g:quantity>
+ * + * <g:quantity>0</g:quantity>
+ * + * Not acceptable:
+ * <g:quantity>out + * of stock</g:quantity>
+ * + * Attribute of + * Events, Products, + * Services, Travel, Vehicles
+ * Content type + * + * integer
+ * @param quantity Quantity available. + */ + public void setQuantity(Integer quantity); + + /** + * Quantity available. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * quantity
+ * Details 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.
+ * Example + * Acceptable:
+ * <g:quantity>18</g:quantity>
+ * + * <g:quantity>0</g:quantity>
+ * + * Not acceptable:
+ * <g:quantity>out + * of stock</g:quantity>
+ * + * Attribute of + * Events, Products, + * Services, Travel, Vehicles
+ * Content type + * + * integer
+ * @return Quantity available. + */ + public Integer getQuantity(); + + /** + * The type of service being offered. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * service_type
+ * Details + * The type of service being offered. Web hosting, + * legal, gardening, etc.
+ * Example <g:service_type>consulting</g:service_type>
+ * Attribute of + * Housing
+ * Content type + * string
+ * @param serviceType The type of service being offered. + */ + public void setServiceType(String serviceType); + + /** + * The type of service being offered. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * service_type
+ * Details + * The type of service being offered. Web hosting, + * legal, gardening, etc.
+ * Example <g:service_type>consulting</g:service_type>
+ * Attribute of + * Housing
+ * Content type + * string
+ * @return The type of service being offered. + */ + public String getServiceType(); + + /** + * Shipping options available for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * shipping
+ * Details + * 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:
    + * + *
  • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
    • + *
  • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
    • + *
  • price = + * the price of shipping.
+ * + * Example <g:shipping>
+ * <g:country>US</g:country>
+ * + * <g:service>UPS</g:shipping>
+ * + * <g:price>35.95</g:price>
+ * </g:shipping>
+ * Attribute of + * Products
+ * + * Content type + * shippingType
+ * @param shipping Shipping options available for an item. + */ + public void setShipping(ShippingType[] shipping); + + /** + * Shipping options available for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * shipping
+ * Details + * 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:
    + * + *
  • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
    • + *
  • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
    • + *
  • price = + * the price of shipping.
+ * + * Example <g:shipping>
+ * <g:country>US</g:country>
+ * + * <g:service>UPS</g:shipping>
+ * + * <g:price>35.95</g:price>
+ * </g:shipping>
+ * Attribute of + * Products
+ * + * Content type + * shippingType
+ * @return Shipping options available for an item. + */ + public ShippingType[] getShipping(); + + /** + * Tax rate associated with the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * tax_percent
+ * + * Details + * Tax rate as a percentage.
+ * Example <g:tax_percent>8.2<g:/tax_percent>
+ * + * Attribute of + * + * Products, Events
+ * Content type + * percentType
+ * @param taxPercent Tax rate associated with the event. + */ + public void setTaxPercent(Float taxPercent); + + /** + * Tax rate associated with the service. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * tax_percent
+ * + * Details + * Tax rate as a percentage.
+ * Example <g:tax_percent>8.2<g:/tax_percent>
+ * + * Attribute of + * + * Products, Events
+ * Content type + * percentType
+ * @return Tax rate associated with the event. + */ + public Float getTaxPercent(); + + /** + * Region where tax applies. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * tax_region
+ * Details + * Geographical region a tax rate + * applies to.
+ * + * Example <g:tax_region>California</g:tax_region>
+ * Attribute of + * Product, + * Events,
+ * Content typestring
+ * @param taxRegion Region where tax applies. + */ + public void setTaxRegion(String taxRegion); + + /** + * Region where tax applies. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * tax_region
+ * Details + * Geographical region a tax rate + * applies to.
+ * + * Example <g:tax_region>California</g:tax_region>
+ * Attribute of + * Product, + * Events,
+ * Content typestring
+ * @return Region where tax applies. + */ + public String getTaxRegion(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/Travel.java b/src/main/java/com/sun/syndication/feed/module/base/Travel.java new file mode 100644 index 0000000..53cbd70 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/Travel.java @@ -0,0 +1,1384 @@ +/* + * Travel.java + * + * Created on November 16, 2005, 3:15 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.feed.module.base.types.CurrencyEnumeration; +import com.sun.syndication.feed.module.base.types.DateTimeRange; +import com.sun.syndication.feed.module.base.types.FloatUnit; +import com.sun.syndication.feed.module.base.types.PaymentTypeEnumeration; +import com.sun.syndication.feed.module.base.types.PriceTypeEnumeration; +import com.sun.syndication.feed.module.base.types.ShippingType; + + +/**This is an interface for the GoogleBase plug in that exposes methods used for + * travel items. + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public interface Travel extends GlobalInterface { + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @param value Currency of the price amount for an item. + */ + public void setCurrency(CurrencyEnumeration value); + + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @return Currency of the price amount for an item. + */ + public CurrencyEnumeration getCurrency(); + + /** + * Additional instructions to explain the item’s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @param deliveryNotes Additional instructions to explain the item’s delivery process. + */ + public void setDeliveryNotes(String deliveryNotes); + + /** + * Additional instructions to explain the item’s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @return Additional instructions to explain the item’s delivery process. + */ + public String getDeliveryNotes(); + + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @param deliveryRadius The maximum distance you will deliver an item in any direction. + */ + public void setDeliveryRadius(FloatUnit deliveryRadius); + + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @return The maximum distance you will deliver an item in any direction. + */ + public FloatUnit getDeliveryRadius(); + + /** + * Starting city and state/country of the trip. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
from_location
Details Starting city and state/country of the trip.
Example Acceptable:
+ * <g:from_location>San Francisco, CA</g:from_location>
+ * + * <g:from_location>Paris, France</g:from_location>
+ * + * Not acceptable:
+ * <g:from_location> San Francisco + * International Airport</g:from_location>
Attribute of Travel
Content type location
+ * @param fromLocation Starting city and state/country of the trip. + */ + public void setFromLocation(String fromLocation); + + /** + * Starting city and state/country of the trip. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
from_location
Details Starting city and state/country of the trip.
Example Acceptable:
+ * <g:from_location>San Francisco, CA</g:from_location>
+ * + * <g:from_location>Paris, France</g:from_location>
+ * + * Not acceptable:
+ * <g:from_location> San Francisco + * International Airport</g:from_location>
Attribute of Travel
Content type location
+ * @return Starting city and state/country of the trip. + */ + public String getFromLocation(); + + /** + * Acceptable payment methods for item purchases. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_accepted
+ * Details 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 + * <payment_accepted> attribute + * for each acceptable method.
+ * Example + * Acceptable:
+ * <g:payment_accepted>Cash</g:payment_accepted>
+ * + * <g:payment_accepted>Check</g:payment_accepted>
+ * Not acceptable:
+ * <g:payment_accepted>Cash + * Check</g:payment_accepted>
+ * Attribute of + * Events, Housing, + * Products, Services, Travel, Vehicles
+ * Content type + * + * paymentMethodEnumeration
+ * @param paymentAccepted Acceptable payment methods for item purchases. + */ + public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted); + + /** + * Acceptable payment methods for item purchases. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_accepted
+ * Details 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 + * <payment_accepted> attribute + * for each acceptable method.
+ * Example + * Acceptable:
+ * <g:payment_accepted>Cash</g:payment_accepted>
+ * + * <g:payment_accepted>Check</g:payment_accepted>
+ * Not acceptable:
+ * <g:payment_accepted>Cash + * Check</g:payment_accepted>
+ * Attribute of + * Events, Housing, + * Products, Services, Travel, Vehicles
+ * Content type + * + * paymentMethodEnumeration
+ * @return Acceptable payment methods for item purchases. + */ + public PaymentTypeEnumeration[] getPaymentAccepted(); + + /** + * Additional instructions to explain a payment policy. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * + * Content type + * string
+ * @param paymentNotes Additional instructions to explain a payment policy. + */ + public void setPaymentNotes(String paymentNotes); + + /** + * Additional instructions to explain a payment policy. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * + * Content type + * string
+ * @return Additional instructions to explain a payment policy. + */ + public String getPaymentNotes(); + + /** + * Price of the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * price
+ * Details Prices can be a single price, 0 + * (free), or blank if not applicable. Numerice values only. When used + * as a sub-attribute of <shipping>, the value included reflects the price + * of shipping.
+ * Example + * Acceptable:
+ * <g:price>5.95</g:price>
+ * + * <g:price>0</g:price>
+ * Not acceptable:
+ * <g:price>5,95</g:price>
+ * <g:price>5.00 – 10.00</g:price>
+ * + * <g:price>100 or best offer</g:price>
+ * <g:price>free</g:price>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content typefloatUnit
+ * @return Price of the item. + */ + public FloatUnit getPrice(); + + /** + * The type of pricing for the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
price_type
DetailsThe type of pricing for the + * item. Acceptable values are “negotiable,” or “starting.” The default is + * “starting”
ExampleAcceptable:
+ * <g:price_type>starting</g:price_type>
+ * Not acceptable:
+ * <g:price_type>100 OBO</g:price_type>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * priceTypeEnumeration
+ * @param priceType The type of pricing for the item. + */ + public void setPriceType(PriceTypeEnumeration priceType); + + /** + * The type of pricing for the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
price_type
DetailsThe type of pricing for the + * item. Acceptable values are “negotiable,” or “starting.” The default is + * “starting”
ExampleAcceptable:
+ * <g:price_type>starting</g:price_type>
+ * Not acceptable:
+ * <g:price_type>100 OBO</g:price_type>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * priceTypeEnumeration
+ * @return The type of pricing for the item. + */ + public PriceTypeEnumeration getPriceType(); + + + /** + * Quantity available. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * quantity
+ * Details 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.
+ * Example + * Acceptable:
+ * <g:quantity>18</g:quantity>
+ * + * <g:quantity>0</g:quantity>
+ * + * Not acceptable:
+ * <g:quantity>out + * of stock</g:quantity>
+ * + * Attribute of + * Events, Products, + * Services, Travel, Vehicles
+ * Content type + * + * integer
+ * @param quantity Quantity available. + */ + public void setQuantity(Integer quantity); + + /** + * Quantity available. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * quantity
+ * Details 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.
+ * Example + * Acceptable:
+ * <g:quantity>18</g:quantity>
+ * + * <g:quantity>0</g:quantity>
+ * + * Not acceptable:
+ * <g:quantity>out + * of stock</g:quantity>
+ * + * Attribute of + * Events, Products, + * Services, Travel, Vehicles
+ * Content type + * + * integer
+ * @return Quantity available. + */ + public Integer getQuantity(); + + + /** + * Tax rate associated with the event. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * tax_percent
+ * + * Details + * Tax rate as a percentage.
+ * Example <g:tax_percent>8.2<g:/tax_percent>
+ * + * Attribute of + * + * Products, Events
+ * Content type + * percentType
+ * @param taxPercent Tax rate associated with the event. + */ + public void setTaxPercent(Float taxPercent); + + /** + * Tax rate associated with the service. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * tax_percent
+ * + * Details + * Tax rate as a percentage.
+ * Example <g:tax_percent>8.2<g:/tax_percent>
+ * + * Attribute of + * + * Products, Events
+ * Content type + * percentType
+ * @return Tax rate associated with the event. + */ + public Float getTaxPercent(); + + /** + * Region where tax applies. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * tax_region
+ * Details + * Geographical region a tax rate + * applies to.
+ * + * Example <g:tax_region>California</g:tax_region>
+ * Attribute of + * Product, + * Events,
+ * Content typestring
+ * @param taxRegion Region where tax applies. + */ + public void setTaxRegion(String taxRegion); + + /** + * Region where tax applies. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * tax_region
+ * Details + * Geographical region a tax rate + * applies to.
+ * + * Example <g:tax_region>California</g:tax_region>
+ * Attribute of + * Product, + * Events,
+ * Content typestring
+ * @return Region where tax applies. + */ + public String getTaxRegion(); + + /** + * Destination city and state/country of the trip. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * to_location
+ * + * Details + * Destination city and state/country + * of the trip.
+ * + * Example + * Acceptable:
+ * <g:to_location>San + * Francisco, CA</g:to_location>
+ * <g:to_location>Paris, France</g:to_location>
+ * + * Not acceptable:
+ * <g:to_location>San + * Francisco International Airport</g:to_location>
+ * + * Attribute of + * Travel
+ * Content type + * locationyTpe
+ * @param toLocation Destination city and state/country of the trip. + */ + public void setToLocation(String toLocation); + + /** + * Destination city and state/country of the trip. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * to_location
+ * + * Details + * Destination city and state/country + * of the trip.
+ * + * Example + * Acceptable:
+ * <g:to_location>San + * Francisco, CA</g:to_location>
+ * <g:to_location>Paris, France</g:to_location>
+ * + * Not acceptable:
+ * <g:to_location>San + * Francisco International Airport</g:to_location>
+ * + * Attribute of + * Travel
+ * Content type + * locationyTpe
+ * @return Destination city and state/country of the trip. + */ + public String getToLocation(); + + /** + * Departure date and time of the trip. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * travel_date_range
+ * Details + * Departure date and time of the trip in ISO 8601 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.
    + * + *
  • start = Start date and time of a trip in + * format YYYY-MM-DDThh:mm:ss
    • + *
  • end = End date and time of a trip in + * format YYYY-MM-DDThh:mm:ss
+ * Example <g:travel_date_range>
+ * + * <g:start>2005-12-20T06:00:00</g:start> + *
+ * <g:end>2005-12-29T13:00:00</g:end>
+ * </g:travel_date_range>
+ * + * Attribute of + * Travel
+ * + * Content type + * dateTimeRange
+ * @param travelDateRange Departure date and time of the trip. + */ + public void setTravelDateRange(DateTimeRange travelDateRange); + + /** + * Departure date and time of the trip. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * travel_date_range
+ * Details + * Departure date and time of the trip in ISO 8601 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.
    + * + *
  • start = Start date and time of a trip in + * format YYYY-MM-DDThh:mm:ss
    • + *
  • end = End date and time of a trip in + * format YYYY-MM-DDThh:mm:ss
+ * Example <g:travel_date_range>
+ * + * <g:start>2005-12-20T06:00:00</g:start> + *
+ * <g:end>2005-12-29T13:00:00</g:end>
+ * </g:travel_date_range>
+ * + * Attribute of + * Travel
+ * + * Content type + * dateTimeRange
+ * @return Departure date and time of the trip. + */ + public DateTimeRange getTravelDateRange(); + /** + * Location of the property. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @param location Location of the property. + */ + public void setLocation(String location); + + /** + * Location of the property. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @return Location of the property. + */ + public String getLocation(); + + + /** + * Shipping options available for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * shipping
+ * Details + * 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:
    + * + *
  • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
    • + *
  • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
    • + *
  • price = + * the price of shipping.
+ * + * Example <g:shipping>
+ * <g:country>US</g:country>
+ * + * <g:service>UPS</g:shipping>
+ * + * <g:price>35.95</g:price>
+ * </g:shipping>
+ * Attribute of + * Products
+ * + * Content type + * shippingType
+ * @return Shipping options available for an item. + */ + public ShippingType[] getShipping(); + + +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/Unknown.java b/src/main/java/com/sun/syndication/feed/module/base/Unknown.java new file mode 100644 index 0000000..3d4bc65 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/Unknown.java @@ -0,0 +1,78 @@ +/* + * Unknown.java + * + * Created on November 18, 2005, 1:34 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import java.net.URL; + +import com.sun.syndication.feed.module.base.types.IntUnit; + + +/** + * This interface contains all the other schema elements that the document + * doesn't associate with a particular type. + * + * @author Robert "kebernet" + * Cooper + */ +public interface Unknown extends GlobalInterface { + public void setLicenses(String[] licenses); + + public String[] getLicenses(); + + public void setOperatingSystems(String systems); + + public String getOperatingSystems(); + + public void setProgrammingLanguages(String[] languages); + + public String[] getProgrammingLanguages(); + + public void setRelatedLinks(URL[] links); + + public URL[] getRelatedLinks(); + + public void setSquareFootages(IntUnit[] squareFootages); + + public IntUnit[] getSquareFootages(); + + public void setSubjectAreas(String[] subjectAreas); + + public String[] getSubjectAreas(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/ValidationException.java b/src/main/java/com/sun/syndication/feed/module/base/ValidationException.java new file mode 100644 index 0000000..ae0072d --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/ValidationException.java @@ -0,0 +1,35 @@ +/* + * ValidationException.java + * + * Created on November 20, 2005, 3:14 PM + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +package com.sun.syndication.feed.module.base; + +/** This is an unchecked exception that is thrown when a data value violates + * the Google Schema limits. + * @version $Revision: 1.1 $ + * @author Robert "kebernet" Cooper + */ +public class ValidationException extends RuntimeException{ + + /** Creates a new instance of ValidationException */ + public ValidationException(String message) { + super( message ); + } + +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/Vehicle.java b/src/main/java/com/sun/syndication/feed/module/base/Vehicle.java new file mode 100644 index 0000000..24bb729 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/Vehicle.java @@ -0,0 +1,1895 @@ +/* + * Vehicle.java + * + * Created on November 16, 2005, 3:26 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.feed.module.base.types.CurrencyEnumeration; +import com.sun.syndication.feed.module.base.types.FloatUnit; +import com.sun.syndication.feed.module.base.types.PaymentTypeEnumeration; +import com.sun.syndication.feed.module.base.types.PriceTypeEnumeration; +import com.sun.syndication.feed.module.base.types.ShippingType; +import com.sun.syndication.feed.module.base.types.YearType; + + +/** + * This is an interface for the GoogleBase plug in that exposes methods used for + * vehicles. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public interface Vehicle extends GlobalInterface { + /** + * Color of an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * color
+ * Details + * Color of an item.
+ * Example <g:color>Black</g:color>
+ * + * Attribute of + * Products, Vehicles
+ * Content type + * string
+ * @param color Color of an item. + */ + public void setColors(String[] color); + + /** + * Color of an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * color
+ * Details + * Color of an item.
+ * Example <g:color>Black</g:color>
+ * + * Attribute of + * Products, Vehicles
+ * Content type + * string
+ * @return Color of an item. + */ + public String[] getColors(); + + /** + * Condition of the item. For example: new, used, or refurbished. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
condition
Details Condition + * of the item. For example: new, used, or refurbished.
Example + * <g:condition>refurbished</g:condition>
Attribute + * of Products, + * Vehicles
Content + * type string
+ * @param condition Condition of the item. For example: new, used, or refurbished. + */ + public void setCondition(String condition); + + /** + * Condition of the item. For example: new, used, or refurbished. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
condition
Details Condition + * of the item. For example: new, used, or refurbished.
Example + * <g:condition>refurbished</g:condition>
Attribute + * of Products, + * Vehicles
Content + * type string
+ * @return Condition of the item. For example: new, used, or refurbished. + */ + public String getCondition(); + + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @param value Currency of the price amount for an item. + */ + public void setCurrency(CurrencyEnumeration value); + + /** + * Currency of the price amount for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
currency
Details Currency + * of the price amount for an item. Values must be in ISO + * 4217 currency code format.
Example Acceptable:
<g:currency>USD</g:currency>
+ * + * Not acceptable:
<g:currency>US Dollars</g:currency>
Attribute + * of Events, + * Housing, Products, Services, Travel, Vehicles
Content + * type currencyEnumeration
+ * @return Currency of the price amount for an item. + */ + public CurrencyEnumeration getCurrency(); + + /** + * Additional instructions to explain the item’s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @param deliveryNotes Additional instructions to explain the item’s delivery process. + */ + public void setDeliveryNotes(String deliveryNotes); + + /** + * Additional instructions to explain the item’s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @return Additional instructions to explain the item’s delivery process. + */ + public String getDeliveryNotes(); + + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @param deliveryRadius The maximum distance you will deliver an item in any direction. + */ + public void setDeliveryRadius(FloatUnit deliveryRadius); + + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @return The maximum distance you will deliver an item in any direction. + */ + public FloatUnit getDeliveryRadius(); + + /** + * Location of a property. Should include street, city, state, postal code, and country, in that order. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @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
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @return Location of a property. Should include street, city, state, postal code, and country, in that order. + */ + public String getLocation(); + + + /** + * The vehicle manufacturer. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * make
+ * + * Details + * + * The vehicle manufacturer.
+ * Example <g:make>Honda</g:make>
+ * Attribute of + * + * Vehicles
+ * Content type + * string
+ * @param make The vehicle manufacturer. + */ + public void setMake(String make); + + /** + * The vehicle manufacturer. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * make
+ * + * Details + * + * The vehicle manufacturer.
+ * Example <g:make>Honda</g:make>
+ * Attribute of + * + * Vehicles
+ * Content type + * string
+ * @return The vehicle manufacturer. + */ + public String getMake(); + + /** + * Current mileage of the vehicle. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
mileage
Details Current mileage of the vehicle.
+ * + * Example + * <g:mileage>1700</g:mileage>
+ *
+ * <g:mileage>1,700 miles</g:mileage>
+ * Attribute of + * Vehicles
+ * Content type + * intUnit
+ * @param mileage Current mileage of the vehicle. + */ + public void setMileage(Integer mileage); + + /** + * Current mileage of the vehicle. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
mileage
Details Current mileage of the vehicle.
+ * + * Example + * <g:mileage>1700</g:mileage>
+ *
+ * <g:mileage>1,700 miles</g:mileage>
+ * Attribute of + * Vehicles
+ * Content type + * intUnit
+ * @return Current mileage of the vehicle. + */ + public Integer getMileage(); + + /** + * The vehicle model. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
model
DetailsThe vehicle model.
Example <g:model>Camry</g:model>
Attribute of + * Vehicles
Content typestring
+ * @param model The vehicle model. + */ + public void setModel(String model); + + /** + * The vehicle model. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
model
DetailsThe vehicle model.
Example <g:model>Camry</g:model>
Attribute of + * Vehicles
Content typestring
+ * @return The vehicle model. + */ + public String getModel(); + +/** + * Payment Methods acceptable for the service. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_accepted
+ * Details 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 + * <payment_accepted> attribute for each acceptable method.
+ * Example + * Acceptable:
+ * <g:payment_accepted>Cash</g:payment_accepted>
+ * + * <g:payment_accepted>Check</g:payment_accepted>
+ * + * <g:payment_accepted>Paypal</g:payment_accepted>
+ * Not acceptable:
+ * <g:payment_accepted>Cash + * Check Paypal</g:payment_accepted>
+ * Attribute of + * Events, Housing, + * Products, Services, Travel, Vehicles
+ * Content type + * paymentMethodEnumeration
+ * @param paymentAccepted Payment Methods acceptable for the service. + */ + public void setPaymentAccepted(PaymentTypeEnumeration[] paymentAccepted); + + /** + * Payment Methods acceptable for the service. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_accepted
+ * Details 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 + * <payment_accepted> attribute for each acceptable method.
+ * Example + * Acceptable:
+ * <g:payment_accepted>Cash</g:payment_accepted>
+ * + * <g:payment_accepted>Check</g:payment_accepted>
+ * + * <g:payment_accepted>Paypal</g:payment_accepted>
+ * Not acceptable:
+ * <g:payment_accepted>Cash + * Check Paypal</g:payment_accepted>
+ * Attribute of + * Events, Housing, + * Products, Services, Travel, Vehicles
+ * Content type + * paymentMethodEnumeration
+ * @return Payment Methods acceptable for the service. + */ + public PaymentTypeEnumeration[] getPaymentAccepted(); + + /** + * Additional payment information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * string
+ * @param paymentNotes Additional payment information. + */ + public void setPaymentNotes(String paymentNotes); + + /** + * Additional payment information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * payment_notes
+ * Details + * Additional instructions to explain + * a payment policy.
+ * Example <g:payment_notes>Cash only for local orders.</g:payment_notes>
+ * Attribute of + * + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * string
+ * @return Additional payment information. + */ + public String getPaymentNotes(); + + /** + * Price for the service. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * price
+ * Details Prices can be a single price, 0 + * (free), or blank if not applicable. Numerice values only. When used + * as a sub-attribute of <shipping>, the value included reflects the price + * of shipping.
+ * Example + * Acceptable:
+ * <g:price>5.95</g:price>
+ * + * <g:price>0</g:price>
+ * Not acceptable:
+ * <g:price>5,95</g:price>
+ * <g:price>5.00 � 10.00</g:price>
+ * + * <g:price>100 or best offer</g:price>
+ * <g:price>free</g:price>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content typefloatUnit
+ * @param price Price for the service. + */ + public void setPrice(FloatUnit price); + + /** + * Price for the service. + *
+ * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * price
+ * Details Prices can be a single price, 0 + * (free), or blank if not applicable. Numerice values only. When used + * as a sub-attribute of <shipping>, the value included reflects the price + * of shipping.
+ * Example + * Acceptable:
+ * <g:price>5.95</g:price>
+ * + * <g:price>0</g:price>
+ * Not acceptable:
+ * <g:price>5,95</g:price>
+ * <g:price>5.00 � 10.00</g:price>
+ * + * <g:price>100 or best offer</g:price>
+ * <g:price>free</g:price>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content typefloatUnit
+ * @return Price for the service. + */ + public FloatUnit getPrice(); + + /** + * Price type information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
price_type
DetailsThe type of pricing for the + * item. Acceptable values are �negotiable,� or �starting.� The default is + * �starting�
ExampleAcceptable:
+ * <g:price_type>starting</g:price_type>
+ * Not acceptable:
+ * <g:price_type>100 OBO</g:price_type>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * priceTypeEnumeration
+ * @param priceType Price type information. + */ + public void setPriceType(PriceTypeEnumeration priceType); + + /** + * Price type information. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
price_type
DetailsThe type of pricing for the + * item. Acceptable values are �negotiable,� or �starting.� The default is + * �starting�
ExampleAcceptable:
+ * <g:price_type>starting</g:price_type>
+ * Not acceptable:
+ * <g:price_type>100 OBO</g:price_type>
+ * Attribute of + * Events, + * Housing, Products, Services, Travel, Vehicles
+ * Content type + * priceTypeEnumeration
+ * @return Price type information. + */ + public PriceTypeEnumeration getPriceType(); + + + /** + * Quantity available. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * quantity
+ * Details 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.
+ * Example + * Acceptable:
+ * <g:quantity>18</g:quantity>
+ * + * <g:quantity>0</g:quantity>
+ * + * Not acceptable:
+ * <g:quantity>out + * of stock</g:quantity>
+ * + * Attribute of + * Events, Products, + * Services, Travel, Vehicles
+ * Content type + * + * integer
+ * @param quantity Quantity available. + */ + public void setQuantity(Integer quantity); + + /** + * Quantity available. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * quantity
+ * Details 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.
+ * Example + * Acceptable:
+ * <g:quantity>18</g:quantity>
+ * + * <g:quantity>0</g:quantity>
+ * + * Not acceptable:
+ * <g:quantity>out + * of stock</g:quantity>
+ * + * Attribute of + * Events, Products, + * Services, Travel, Vehicles
+ * Content type + * + * integer
+ * @return Quantity available. + */ + public Integer getQuantity(); + + /** + * Shipping options available for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * shipping
+ * Details + * 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:
    + * + *
  • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
    • + *
  • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
    • + *
  • price = + * the price of shipping.
+ * + * Example <g:shipping>
+ * <g:country>US</g:country>
+ * + * <g:service>UPS</g:shipping>
+ * + * <g:price>35.95</g:price>
+ * </g:shipping>
+ * Attribute of + * Products
+ * + * Content type + * shippingType
+ * @param shipping Shipping options available for an item. + */ + public void setShipping(ShippingType[] shipping); + + /** + * Shipping options available for an item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * shipping
+ * Details + * 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:
    + * + *
  • service = The type of service used to ship an item. Acceptable values are 'FedEx', 'UPS', 'DHL', 'Mail', and 'Other'
    • + *
  • country = The country an item will ship to. Only acceptable values are ISO 3166 country codes.
    • + *
  • price = + * the price of shipping.
+ * + * Example <g:shipping>
+ * <g:country>US</g:country>
+ * + * <g:service>UPS</g:shipping>
+ * + * <g:price>35.95</g:price>
+ * </g:shipping>
+ * Attribute of + * Products
+ * + * Content type + * shippingType
+ * @return Shipping options available for an item. + */ + public ShippingType[] getShipping(); + + + + /** + * Tax rate associated with the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * tax_percent
+ * + * Details + * Tax rate as a percentage.
+ * Example <g:tax_percent>8.2<g:/tax_percent>
+ * + * Attribute of + * + * Products, Events
+ * Content type + * percentType
+ * @param taxPercent Tax rate associated with the event. + */ + public void setTaxPercent(Float taxPercent); + + /** + * Tax rate associated with the item. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * tax_percent
+ * + * Details + * Tax rate as a percentage.
+ * Example <g:tax_percent>8.2<g:/tax_percent>
+ * + * Attribute of + * + * Products, Events
+ * Content type + * percentType
+ * @return Tax rate associated with the event. + */ + public Float getTaxPercent(); + + /** + * Region where tax applies. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * tax_region
+ * Details + * Geographical region a tax rate + * applies to.
+ * + * Example <g:tax_region>California</g:tax_region>
+ * Attribute of + * Product, + * Events,
+ * Content typestring
+ * @param taxRegion Region where tax applies. + */ + public void setTaxRegion(String taxRegion); + + /** + * Region where tax applies. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * tax_region
+ * Details + * Geographical region a tax rate + * applies to.
+ * + * Example <g:tax_region>California</g:tax_region>
+ * Attribute of + * Product, + * Events,
+ * Content typestring
+ * @return Region where tax applies. + */ + public String getTaxRegion(); + + + /** + * The type of vehicle: Car, motorcycle, scooter, etc. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * vehicle_type
+ * Details + * The type of vehicle: Car, motorcycle, scooter, etc. + *
+ * + * Example <g:vehicle_type>truck</g:vehicle_type>
+ * Attribute of + * Products
+ * + * Content type + * + * string
+ * @param vehicleType The type of vehicle: Car, motorcycle, scooter, etc. + */ + public void setVehicleType(String vehicleType); + + /** + * The type of vehicle: Car, motorcycle, scooter, etc. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * + * vehicle_type
+ * Details + * The type of vehicle: Car, motorcycle, scooter, etc. + *
+ * + * Example <g:vehicle_type>truck</g:vehicle_type>
+ * Attribute of + * Products
+ * + * Content type + * + * string
+ * @return The type of vehicle: Car, motorcycle, scooter, etc. + */ + public String getVehicleType(); + + /** + * Vehicle Identification Number. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * vin
+ * Details + * Vehicle Identification Number.
+ * Example <g:vin>1M8GDM9AXKP042788</g:vin>
+ * Attribute of + * Vehicles
+ * + * Content type + * string
+ * @param vin Vehicle Identification Number. + */ + public void setVin(String vin); + + /** + * Vehicle Identification Number. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * vin
+ * Details + * Vehicle Identification Number.
+ * Example <g:vin>1M8GDM9AXKP042788</g:vin>
+ * Attribute of + * Vehicles
+ * + * Content type + * string
+ * @return Vehicle Identification Number. + */ + public String getVin(); + + /** + * The four digit model year or year built. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * year
+ * Details + * The four digit model year or year built. Format + * YYYY
+ * + * Example + * Acceptable:
+ * + * <g:year>2005</g:year>
+ * Not acceptable:
+ * <g:year>79</g:year>
+ * + * <g:year>26</g:year>
+ * Attribute of + * Housing, Vehicles
+ * + * Content type + * year
+ * @param year The four digit model year or year built. + */ + public void setYear(YearType year); + + /** + * The four digit model year or year built. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * year
+ * Details + * The four digit model year or year built. Format + * YYYY
+ * + * Example + * Acceptable:
+ * + * <g:year>2005</g:year>
+ * Not acceptable:
+ * <g:year>79</g:year>
+ * + * <g:year>26</g:year>
+ * Attribute of + * Housing, Vehicles
+ * + * Content type + * year
+ * @return The four digit model year or year built. + */ + public YearType getYear(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/Wanted.java b/src/main/java/com/sun/syndication/feed/module/base/Wanted.java new file mode 100644 index 0000000..67a5f8e --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/Wanted.java @@ -0,0 +1,306 @@ +/* + * Wanted.java + * + * Created on November 16, 2005, 3:32 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base; + +import com.sun.syndication.feed.module.base.types.FloatUnit; + + +/**This is an interface for the GoogleBase plug in that exposes methods used for + * wanted ads. + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public interface Wanted extends GlobalInterface { + /** + * Additional instructions to explain the item’s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @param deliveryNotes Additional instructions to explain the item’s delivery process. + */ + public void setDeliveryNotes(String deliveryNotes); + + /** + * Additional instructions to explain the item’s delivery process. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_notes
Details Additional instructions to explain the item’s delivery process.
Example + * <g:delivery_notes>Items usually shipped within 24 hours.<g:/delivery_notes>
+ * + *
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type string
+ * @return Additional instructions to explain the item’s delivery process. + */ + public String getDeliveryNotes(); + + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @param deliveryRadius The maximum distance you will deliver an item in any direction. + */ + public void setDeliveryRadius(FloatUnit deliveryRadius); + + /** + * The maximum distance you will deliver an item in any direction. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
delivery_radius
Details The maximum + * distance you will deliver an item in any direction.
Example + * <g:delivery_radius>10<g:/delivery_radius> + * + *
<g:delivery_radius>10km</g:delivery_radius>
Attribute + * of + * Events, Products, Reviews, Services, Travel, Vehicles, Wanted + * Ads.
Content + * type floatUnit
+ * @return The maximum distance you will deliver an item in any direction. + */ + public FloatUnit getDeliveryRadius(); + +/** + * Location of the property. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @param location Location of the property. + */ + public void setLocation(String location); + + /** + * Location of the property. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
+ * location
+ * Details Location of a property. Should + * include street, city, state, postal code, and country, in that order.
+ * Example + * Acceptable:
+ * <g:location>123 Main St, Anytown, CA, 12345, USA</g:location>
+ * + * Not acceptable:
+ * <g:location>123 Main St,, CA, 12345, USA</g:location>
+ * <g:location> + * Anytown, CA, 12345, USA</g:location>
+ * Attribute of + * Reference Items, Events, Housing, Jobs, News and Articles, + * People profiles, Products, Reviews, Services, Travel, Vehicles, Wanted Ads.
+ * Content type + * locationType
+ * @return Location of the property. + */ + public String getLocation(); + +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/io/CustomTagGenerator.java b/src/main/java/com/sun/syndication/feed/module/base/io/CustomTagGenerator.java new file mode 100644 index 0000000..07539d8 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/io/CustomTagGenerator.java @@ -0,0 +1,135 @@ +/* + * CustomTagGenerator.java + * + * Created on February 6, 2006, 1:08 AM + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ +package com.sun.syndication.feed.module.base.io; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.feed.module.base.CustomTag; +import com.sun.syndication.feed.module.base.CustomTagImpl; +import com.sun.syndication.feed.module.base.CustomTags; +import com.sun.syndication.feed.module.base.types.DateTimeRange; +import com.sun.syndication.feed.module.base.types.FloatUnit; +import com.sun.syndication.feed.module.base.types.IntUnit; +import com.sun.syndication.feed.module.base.types.ShortDate; +import com.sun.syndication.io.ModuleGenerator; + +import org.jdom.Element; + +import java.net.URL; + +import java.util.Date; +import java.util.HashSet; +import java.util.Iterator; +import java.util.List; + + +/** + * @version $Revision: 1.1 $ + * @author Robert "kebernet" Cooper + */ +public class CustomTagGenerator implements ModuleGenerator { + static final HashSet NAMESPACES = new HashSet(); + + static { + NAMESPACES.add(CustomTagParser.NS); + } + + /** Creates a new instance of CustomTagGenerator */ + public CustomTagGenerator() { + } + + public String getNamespaceUri() { + return CustomTags.URI; + } + + public java.util.Set getNamespaces() { + return NAMESPACES; + } + + public void generate(Module module,Element element) { + if(!(module instanceof CustomTags)) { + return; + } + + List tags = ((CustomTags)module).getValues(); + Iterator it = tags.iterator(); + + while(it.hasNext()) { + CustomTag tag = (CustomTag)it.next(); + + if(tag.getValue() instanceof DateTimeRange) { + DateTimeRange dtr = (DateTimeRange)tag.getValue(); + Element newTag = new Element(tag.getName(),CustomTagParser.NS); + newTag.setAttribute("type","dateTimeRange"); + newTag.addContent(this.generateSimpleElement("start",GoogleBaseParser.LONG_DT_FMT.format(dtr.getStart()))); + newTag.addContent(this.generateSimpleElement("end",GoogleBaseParser.LONG_DT_FMT.format(dtr.getEnd()))); + element.addContent(newTag); + } else if(tag.getValue() instanceof ShortDate) { + ShortDate sd = (ShortDate)tag.getValue(); + Element newTag = this.generateSimpleElement(tag.getName(),GoogleBaseParser.SHORT_DT_FMT.format(sd)); + newTag.setAttribute("type","date"); + element.addContent(newTag); + } else if(tag.getValue() instanceof Date) { + Date d = (Date)tag.getValue(); + Element newTag = this.generateSimpleElement(tag.getName(),GoogleBaseParser.SHORT_DT_FMT.format(d)); + newTag.setAttribute("type","dateTime"); + element.addContent(newTag); + } else if(tag.getValue() instanceof Integer) { + Element newTag = this.generateSimpleElement(tag.getName(),tag.getValue().toString()); + newTag.setAttribute("type","int"); + element.addContent(newTag); + } else if(tag.getValue() instanceof IntUnit) { + Element newTag = this.generateSimpleElement(tag.getName(),tag.getValue().toString()); + newTag.setAttribute("type","intUnit"); + element.addContent(newTag); + } else if(tag.getValue() instanceof Float) { + Element newTag = this.generateSimpleElement(tag.getName(),tag.getValue().toString()); + newTag.setAttribute("type","float"); + element.addContent(newTag); + } else if(tag.getValue() instanceof FloatUnit) { + Element newTag = this.generateSimpleElement(tag.getName(),tag.getValue().toString()); + newTag.setAttribute("type","floatUnit"); + element.addContent(newTag); + } else if(tag.getValue() instanceof String) { + Element newTag = this.generateSimpleElement(tag.getName(),tag.getValue().toString()); + newTag.setAttribute("type","string"); + element.addContent(newTag); + } else if(tag.getValue() instanceof URL) { + Element newTag = this.generateSimpleElement(tag.getName(),tag.getValue().toString()); + newTag.setAttribute("type","url"); + element.addContent(newTag); + } else if(tag.getValue() instanceof Boolean) { + Element newTag = this.generateSimpleElement(tag.getName(),tag.getValue().toString()); + newTag.setAttribute("type","boolean"); + element.addContent(newTag); + } else if( tag.getValue() instanceof CustomTagImpl.Location ){ + Element newTag = this.generateSimpleElement(tag.getName(),tag.getValue().toString()); + newTag.setAttribute("type","location"); + element.addContent(newTag); + } + } + } + + protected Element generateSimpleElement(String name,String value) { + Element element = new Element(name,CustomTagParser.NS); + element.addContent(value); + + return element; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/io/CustomTagParser.java b/src/main/java/com/sun/syndication/feed/module/base/io/CustomTagParser.java new file mode 100644 index 0000000..1724c5e --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/io/CustomTagParser.java @@ -0,0 +1,122 @@ +/* + * CustomTagParser.java + * + * Created on February 6, 2006, 12:40 AM + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ + +package com.sun.syndication.feed.module.base.io; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.feed.module.base.CustomTagImpl; +import com.sun.syndication.feed.module.base.CustomTags; +import com.sun.syndication.feed.module.base.CustomTagsImpl; +import com.sun.syndication.feed.module.base.types.DateTimeRange; +import com.sun.syndication.feed.module.base.types.FloatUnit; +import com.sun.syndication.feed.module.base.types.IntUnit; +import com.sun.syndication.feed.module.base.types.ShortDate; +import com.sun.syndication.io.ModuleParser; + +import java.net.MalformedURLException; +import java.net.URL; +import java.text.ParseException; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; +import java.util.logging.Level; +import java.util.logging.Logger; +import org.jdom.Element; +import org.jdom.Namespace; + +/** + * @version $Revision: 1.4 $ + * @author Robert "kebernet" Cooper + */ +public class CustomTagParser implements ModuleParser { + private static final Logger log = Logger.getAnonymousLogger(); + + static final Namespace NS = Namespace.getNamespace( "g-custom", CustomTags.URI ); + + /** Creates a new instance of CustomTagParser */ + public CustomTagParser() { + } + + public Module parse(Element element) { + CustomTags module = new CustomTagsImpl(); + ArrayList tags = new ArrayList(); + List elements = element.getChildren(); + Iterator it = elements.iterator(); + while( it.hasNext() ){ + Element child = (Element) it.next(); + if( child.getNamespace().equals( NS ) ){ + String type = child.getAttributeValue( "type" ); + try{ + if( type == null ){ + continue; + } else if( type.equals( "string") ){ + tags.add( new CustomTagImpl( child.getName(), child.getText() ) ); + } else if( type.equals( "int") ){ + tags.add( new CustomTagImpl( child.getName(), new Integer( child.getTextTrim() ))); + } else if( type.equals( "float") ){ + tags.add( new CustomTagImpl( child.getName(), new Float( child.getTextTrim() ) ) ); + } else if( type.equals("intUnit") ){ + tags.add( new CustomTagImpl( child.getName(), new IntUnit( child.getTextTrim()) ) ); + } else if( type.equals( "floatUnit") ){ + tags.add( new CustomTagImpl( child.getName(), new FloatUnit( child.getTextTrim()) ) ); + } else if( type.equals( "date") ){ + try{ + tags.add( new CustomTagImpl( child.getName(), new ShortDate( GoogleBaseParser.SHORT_DT_FMT.parse( child.getTextTrim()))) ); + } catch( ParseException e ){ + log.log( Level.WARNING, "Unable to parse date type on "+child.getName(), e ); + } + } else if( type.equals( "dateTime") ){ + try{ + tags.add( new CustomTagImpl( child.getName(), GoogleBaseParser.LONG_DT_FMT.parse( child.getTextTrim() ))); + } catch(ParseException e){ + log.log( Level.WARNING, "Unable to parse date type on "+child.getName(), e ); + } + } else if( type.equals( "dateTimeRange") ){ + try{ + tags.add( new CustomTagImpl( child.getName(), new DateTimeRange(GoogleBaseParser.LONG_DT_FMT.parse(child.getChild("start",CustomTagParser.NS).getText().trim()),GoogleBaseParser.LONG_DT_FMT.parse(child.getChild("end",CustomTagParser.NS).getText().trim())))); + } catch(Exception e){ + log.log( Level.WARNING, "Unable to parse date type on "+child.getName(), e ); + } + } else if( type.equals( "url") ){ + try{ + tags.add( new CustomTagImpl( child.getName(), new URL( child.getTextTrim() )) ); + } catch( MalformedURLException e){ + log.log( Level.WARNING, "Unable to parse URL type on "+child.getName(), e ); + } + } else if( type.equals( "boolean") ){ + tags.add( new CustomTagImpl( child.getName(), new Boolean( child.getTextTrim().toLowerCase()) )); + } else if( type.equals( "location") ) { + tags.add( new CustomTagImpl( child.getName(), new CustomTagImpl.Location( child.getText() ))); + } else { + throw new Exception( "Unknown type: "+ type ); + } + } catch(Exception e){ + log.log( Level.WARNING, "Unable to parse type on "+child.getName(), e ); + } + } + } + module.setValues( tags ); + return module; + } + + public String getNamespaceUri() { + return CustomTags.URI; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/io/GoogleBaseGenerator.java b/src/main/java/com/sun/syndication/feed/module/base/io/GoogleBaseGenerator.java new file mode 100644 index 0000000..6fae619 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/io/GoogleBaseGenerator.java @@ -0,0 +1,166 @@ +/* + * GoogleBaseGenerator.java + * + * Created on November 17, 2005, 2:46 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base.io; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.io.ModuleGenerator; + +import com.sun.syndication.feed.module.base.GoogleBase; +import com.sun.syndication.feed.module.base.GoogleBaseImpl; +import com.sun.syndication.feed.module.base.types.CurrencyEnumeration; +import com.sun.syndication.feed.module.base.types.DateTimeRange; +import com.sun.syndication.feed.module.base.types.FloatUnit; +import com.sun.syndication.feed.module.base.types.GenderEnumeration; +import com.sun.syndication.feed.module.base.types.IntUnit; +import com.sun.syndication.feed.module.base.types.PaymentTypeEnumeration; +import com.sun.syndication.feed.module.base.types.PriceTypeEnumeration; +import com.sun.syndication.feed.module.base.types.ShippingType; +import com.sun.syndication.feed.module.base.types.ShortDate; +import com.sun.syndication.feed.module.base.types.Size; +import com.sun.syndication.feed.module.base.types.YearType; + +import org.jdom.Element; +import org.jdom.Namespace; + +import java.beans.PropertyDescriptor; + +import java.net.URL; + +import java.util.Date; +import java.util.HashMap; +import java.util.HashSet; +import java.util.Set; + + +/** + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public class GoogleBaseGenerator implements ModuleGenerator { + private static final Namespace NS = Namespace.getNamespace("g-core",GoogleBase.URI); + + /** Creates a new instance of GoogleBaseGenerator */ + public GoogleBaseGenerator() { + super(); + } + + public String getNamespaceUri() { + return GoogleBase.URI; + } + + public Set getNamespaces() { + HashSet set = new HashSet(); + set.add(GoogleBaseGenerator.NS); + + return set; + } + + public void generate(Module module,Element element) { + GoogleBaseImpl mod = (GoogleBaseImpl)module; + HashMap props2tags = new HashMap(GoogleBaseParser.PROPS2TAGS); + PropertyDescriptor[] pds = GoogleBaseParser.pds; + + for(int i = 0; i < pds.length; i++) { + String tagName = (String)props2tags.get(pds[i].getName()); + + if(tagName == null) { + continue; + } + + Object[] values = null; + + try { + if(pds[i].getPropertyType().isArray()) { + values = (Object[])pds[i].getReadMethod().invoke(mod,(Object[])null); + } else { + values = new Object[] { + pds[i].getReadMethod().invoke(mod,(Object[])null) + }; + } + + for(int j = 0; (values != null)&&(j < values.length); j++) { + if(values[j] != null) { + element.addContent(this.generateTag(values[j],tagName)); + } + } + } catch(Exception e) { + e.printStackTrace(); + } + } + } + + public Element generateTag(Object o,String tagName) { + if(o instanceof URL||o instanceof Float||o instanceof Boolean||o instanceof Integer||o instanceof String||o instanceof FloatUnit||o instanceof IntUnit||o instanceof GenderEnumeration||o instanceof PaymentTypeEnumeration||o instanceof PriceTypeEnumeration||o instanceof CurrencyEnumeration||o instanceof Size||o instanceof YearType) { + return this.generateSimpleElement(tagName,o.toString()); + } else if(o instanceof ShortDate) { + return this.generateSimpleElement(tagName,GoogleBaseParser.SHORT_DT_FMT.format(o)); + } else if(o instanceof Date) { + return this.generateSimpleElement(tagName,GoogleBaseParser.LONG_DT_FMT.format(o)); + } else if(o instanceof ShippingType) { + ShippingType st = (ShippingType)o; + Element element = new Element(tagName,GoogleBaseGenerator.NS); + + element.addContent(this.generateSimpleElement("country",st.getCountry())); + + element.addContent(this.generateSimpleElement("service", st.getService().toString() )); + + element.addContent(this.generateSimpleElement("price",st.getPrice().toString())); + + return element; + } else if(o instanceof DateTimeRange) { + DateTimeRange dtr = (DateTimeRange)o; + Element element = new Element(tagName,GoogleBaseGenerator.NS); + element.addContent(this.generateSimpleElement("start",GoogleBaseParser.LONG_DT_FMT.format(dtr.getStart()))); + element.addContent(this.generateSimpleElement("end",GoogleBaseParser.LONG_DT_FMT.format(dtr.getEnd()))); + + return element; + } + + throw new RuntimeException("Unknown class type to handle: " + o.getClass().getName()); + } + + protected Element generateSimpleElement(String name,String value) { + Element element = new Element(name,GoogleBaseGenerator.NS); + element.addContent(value); + + return element; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/io/GoogleBaseParser.java b/src/main/java/com/sun/syndication/feed/module/base/io/GoogleBaseParser.java new file mode 100644 index 0000000..6cd2bb2 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/io/GoogleBaseParser.java @@ -0,0 +1,245 @@ +/* + * GoogleBaseParser.java + * + * Created on November 17, 2005, 11:31 AM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base.io; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.feed.module.base.GoogleBase; +import com.sun.syndication.feed.module.base.GoogleBaseImpl; +import com.sun.syndication.io.ModuleParser; +import com.sun.syndication.feed.module.base.types.CurrencyEnumeration; +import com.sun.syndication.feed.module.base.types.DateTimeRange; +import com.sun.syndication.feed.module.base.types.FloatUnit; +import com.sun.syndication.feed.module.base.types.GenderEnumeration; +import com.sun.syndication.feed.module.base.types.IntUnit; +import com.sun.syndication.feed.module.base.types.PaymentTypeEnumeration; +import com.sun.syndication.feed.module.base.types.PriceTypeEnumeration; +import com.sun.syndication.feed.module.base.types.ShippingType; +import com.sun.syndication.feed.module.base.types.Size; +import com.sun.syndication.feed.module.base.types.YearType; + +import org.jdom.Element; +import org.jdom.Namespace; + +import java.beans.IntrospectionException; +import java.beans.Introspector; +import java.beans.PropertyDescriptor; + +import java.io.IOException; + +import java.lang.reflect.Array; + +import java.net.URL; + +import java.text.SimpleDateFormat; + +import java.util.Date; +import java.util.HashMap; +import java.util.Iterator; +import java.util.List; +import java.util.Properties; +import java.util.logging.Level; +import java.util.logging.Logger; + +/** + * DOCUMENT ME! + * + * @author Robert "kebernet" + * Cooper + * @version $Revision: 1.3 $ + */ +public class GoogleBaseParser implements ModuleParser { + private static final Logger log = Logger.getAnonymousLogger(); + public static final char[] INTEGER_CHARS = "-1234567890".toCharArray(); + public static final char[] FLOAT_CHARS = "-1234567890.".toCharArray(); + public static final SimpleDateFormat SHORT_DT_FMT = new SimpleDateFormat("yyyy-MM-dd"); + public static final SimpleDateFormat LONG_DT_FMT = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss"); + static final Namespace NS = Namespace.getNamespace(GoogleBase.URI); + static final Properties PROPS2TAGS = new Properties(); + static PropertyDescriptor[] pds = null; + + static { + try { + pds = Introspector.getBeanInfo(GoogleBaseImpl.class).getPropertyDescriptors(); + PROPS2TAGS.load(GoogleBaseParser.class.getResourceAsStream("/com/sun/syndication/feed/module/base/io/tags.properties")); + } catch(IOException e) { + e.printStackTrace(); + log.log(Level.SEVERE,"Unable to read properties file for Google Base tags!",e); + } catch(IntrospectionException e) { + e.printStackTrace(); + log.log(Level.SEVERE,"Unable to get property descriptors for GoogleBaseImpl!",e); + } + } + + /** + * Creates a new instance of GoogleBaseParser + */ + public GoogleBaseParser() { + super(); + } + + public Module parse(Element element) { + HashMap tag2pd = new HashMap(); + GoogleBaseImpl module = new GoogleBaseImpl(); + + try { + for(int i = 0; i < pds.length; i++) { + PropertyDescriptor pd = pds[i]; + String tagName = GoogleBaseParser.PROPS2TAGS.getProperty(pd.getName()); + + if(tagName == null) { + log.log(Level.FINE,"Property: " + pd.getName() + " doesn't have a tag mapping. "); + } else { + tag2pd.put(tagName,pd); + } + } + } catch(Exception e) { + throw new RuntimeException("Exception building tag to property mapping. ",e); + } + + List children = element.getChildren(); + Iterator it = children.iterator(); + + while(it.hasNext()) { + Element child = (Element)it.next(); + + if(child.getNamespace().equals(GoogleBaseParser.NS)) { + PropertyDescriptor pd = (PropertyDescriptor)tag2pd.get(child.getName()); + + if(pd != null) { + try { + this.handleTag(child,pd,module); + } catch(Exception e) { + log.log(Level.WARNING,"Unable to handle tag: " + child.getName(),e); + e.printStackTrace(); + } + } + } + } + + return module; + } + + public static String stripNonValidCharacters(char[] validCharacters,String input) { + StringBuffer newString = new StringBuffer(); + + for(int i = 0; i < input.length(); i++) { + for(int j = 0; j < validCharacters.length; j++) { + if(input.charAt(i) == validCharacters[j]) { + newString.append(validCharacters[j]); + } + } + } + + return newString.toString(); + } + + public String getNamespaceUri() { + return GoogleBase.URI; + } + + private void handleTag(Element tag,PropertyDescriptor pd,GoogleBase module) throws Exception { + Object tagValue = null; + + if((pd.getPropertyType() == Integer.class)||(pd.getPropertyType().getComponentType() == Integer.class)) { + tagValue = new Integer(GoogleBaseParser.stripNonValidCharacters(GoogleBaseParser.INTEGER_CHARS,tag.getText())); + } else if((pd.getPropertyType() == Float.class)||(pd.getPropertyType().getComponentType() == Float.class)) { + tagValue = new Float(GoogleBaseParser.stripNonValidCharacters(GoogleBaseParser.FLOAT_CHARS,tag.getText())); + } else if((pd.getPropertyType() == String.class)||(pd.getPropertyType().getComponentType() == String.class)) { + tagValue = tag.getText(); + } else if((pd.getPropertyType() == URL.class)||(pd.getPropertyType().getComponentType() == URL.class)) { + tagValue = new URL(tag.getText().trim()); + } else if((pd.getPropertyType() == Boolean.class)||(pd.getPropertyType().getComponentType() == Boolean.class)) { + tagValue = new Boolean(tag.getText().trim()); + } else if((pd.getPropertyType() == Date.class)||(pd.getPropertyType().getComponentType() == Date.class)) { + String text = tag.getText().trim(); + + if(text.length() > 10) { + tagValue = GoogleBaseParser.LONG_DT_FMT.parse(text); + } else { + tagValue = GoogleBaseParser.SHORT_DT_FMT.parse(text); + } + } else if((pd.getPropertyType() == IntUnit.class)||(pd.getPropertyType().getComponentType() == IntUnit.class)) { + tagValue = new IntUnit(tag.getText()); + } else if((pd.getPropertyType() == FloatUnit.class)||(pd.getPropertyType().getComponentType() == FloatUnit.class)) { + tagValue = new FloatUnit(tag.getText()); + } else if((pd.getPropertyType() == DateTimeRange.class)||(pd.getPropertyType().getComponentType() == DateTimeRange.class)) { + tagValue = new DateTimeRange(LONG_DT_FMT.parse(tag.getChild("start",GoogleBaseParser.NS).getText().trim()),LONG_DT_FMT.parse(tag.getChild("end",GoogleBaseParser.NS).getText().trim())); + } else if((pd.getPropertyType() == ShippingType.class)||(pd.getPropertyType().getComponentType() == ShippingType.class)) { + FloatUnit price = new FloatUnit(tag.getChild("price",GoogleBaseParser.NS).getText().trim()); + ShippingType.ServiceEnumeration service = ShippingType.ServiceEnumeration.findByValue(tag.getChild("service",GoogleBaseParser.NS).getText().trim()); + + if(service == null) { + service = ShippingType.ServiceEnumeration.STANDARD; + } + + String country = tag.getChild("country",GoogleBaseParser.NS).getText().trim(); + tagValue = new ShippingType(price,service,country); + } else if((pd.getPropertyType() == PaymentTypeEnumeration.class)||(pd.getPropertyType().getComponentType() == PaymentTypeEnumeration.class)) { + tagValue = PaymentTypeEnumeration.findByValue(tag.getText().trim()); + } else if((pd.getPropertyType() == PriceTypeEnumeration.class)||(pd.getPropertyType().getComponentType() == PriceTypeEnumeration.class)) { + tagValue = PriceTypeEnumeration.findByValue(tag.getText().trim()); + } else if((pd.getPropertyType() == CurrencyEnumeration.class)||(pd.getPropertyType().getComponentType() == CurrencyEnumeration.class)) { + tagValue = CurrencyEnumeration.findByValue(tag.getText().trim()); + } else if((pd.getPropertyType() == GenderEnumeration.class)||(pd.getPropertyType().getComponentType() == GenderEnumeration.class)) { + tagValue = GenderEnumeration.findByValue(tag.getText().trim()); + } else if((pd.getPropertyType() == YearType.class)||(pd.getPropertyType().getComponentType() == YearType.class)) { + tagValue = new YearType(tag.getText().trim()); + } else if((pd.getPropertyType() == Size.class)||(pd.getPropertyType().getComponentType() == Size.class)) { + tagValue = new Size(tag.getText().trim()); + } + + if(!pd.getPropertyType().isArray()) { + pd.getWriteMethod().invoke(module,new Object[] {tagValue}); + } else { + Object[] current = (Object[])pd.getReadMethod().invoke(module,(Object[])null); + int newSize = (current == null) ? 1 : (current.length + 1); + Object setValue = Array.newInstance(pd.getPropertyType().getComponentType(),newSize); + + int i = 0; + + for(; (current != null)&&(i < current.length); i++) { + Array.set(setValue,i,current[i]); + } + + Array.set(setValue,i,tagValue); + pd.getWriteMethod().invoke(module,new Object[] {setValue}); + } + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/package.html b/src/main/java/com/sun/syndication/feed/module/base/package.html new file mode 100644 index 0000000..49cd810 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/package.html @@ -0,0 +1,72 @@ + + + + + + + + This is the base package for the Google Base ROME module. +

This package contains the core module interface GoogleBase, + as well as the implementation class GoogleBaseImpl. If you want + to work with a specific type of Google Base entry, you can cast it to a + specific item type interface, such as Vehicle.

+

Sample Useage: + 

+        
+        SyndEntry entry = new SyndEntryImpl();
+        // set up the entry...
+        Vehicle vehicle = new GoogleBaseImpl();
+        vehicle.setMake("Honda");
+        vehicle.setModel("Insight");
+        vehicle.setYear( new Year("2000"));
+        List modules = new ArrayList();
+        modules.add( vehicle );
+        entry.setModules( modules );
+        
+        //Optionally, to get Google Base information from a Feed:
+        Article article = entry.getModule( "http://base.google.com/ns/1.0" );
+        System.out.println( article.getPages() );        
+        
+
+

+

Google Base is a trademark of Google, Inc. The authors of this software + are not affiliated with Google, Inc. and Google does not endorse, support, + blah blah blah. +

+ 
+ * This library is provided under dual licenses. 
+ * You may choose the terms of the Lesser General Public License or the Apache
+ * License at your discretion.
+ *
+ *  Copyright (C) 2005  Robert Cooper, Temple of the Screaming Penguin
+ *
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.   
+
+ + diff --git a/src/main/java/com/sun/syndication/feed/module/base/types/CloneableType.java b/src/main/java/com/sun/syndication/feed/module/base/types/CloneableType.java new file mode 100644 index 0000000..b69271f --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/types/CloneableType.java @@ -0,0 +1,50 @@ +/* + * CloneableType.java + * + * Created on November 18, 2005, 10:42 AM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base.types; + + +/** + * This is just a holder interface for cloneable elements. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public interface CloneableType extends Cloneable { + public Object clone(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/types/CurrencyEnumeration.java b/src/main/java/com/sun/syndication/feed/module/base/types/CurrencyEnumeration.java new file mode 100644 index 0000000..7dcbf74 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/types/CurrencyEnumeration.java @@ -0,0 +1,599 @@ +/* + * CurrencyEnumeration.java + * + * Created on November 18, 2005, 11:33 AM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base.types; + +import java.util.HashMap; + + +/** + * An Enumeration of valid currency types. + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public class CurrencyEnumeration { + private static final HashMap lookup = new HashMap(); + + // + // + public static final CurrencyEnumeration AED = new CurrencyEnumeration("AED"); + + // + public static final CurrencyEnumeration AFA = new CurrencyEnumeration("AFA"); + + // + public static final CurrencyEnumeration ALL = new CurrencyEnumeration("ALL"); + + // + public static final CurrencyEnumeration AMD = new CurrencyEnumeration("AMD"); + + // + public static final CurrencyEnumeration ANG = new CurrencyEnumeration("ANG"); + + // + public static final CurrencyEnumeration AOA = new CurrencyEnumeration("AOA"); + + // + public static final CurrencyEnumeration ARS = new CurrencyEnumeration("ARS"); + + // + public static final CurrencyEnumeration AUD = new CurrencyEnumeration("AUD"); + + // + public static final CurrencyEnumeration AWG = new CurrencyEnumeration("AWG"); + + // + public static final CurrencyEnumeration AZM = new CurrencyEnumeration("AZM"); + + // + public static final CurrencyEnumeration BAM = new CurrencyEnumeration("BAM"); + + // + public static final CurrencyEnumeration BBD = new CurrencyEnumeration("BBD"); + + // + public static final CurrencyEnumeration BDT = new CurrencyEnumeration("BDT"); + + // + public static final CurrencyEnumeration BGN = new CurrencyEnumeration("BGN"); + + // + public static final CurrencyEnumeration BHD = new CurrencyEnumeration("BHD"); + + // + public static final CurrencyEnumeration BIF = new CurrencyEnumeration("BIF"); + + // + public static final CurrencyEnumeration BMD = new CurrencyEnumeration("BMD"); + + // + public static final CurrencyEnumeration BND = new CurrencyEnumeration("BND"); + + // + public static final CurrencyEnumeration BOB = new CurrencyEnumeration("BOB"); + + // + public static final CurrencyEnumeration BRL = new CurrencyEnumeration("BRL"); + + // + public static final CurrencyEnumeration BSD = new CurrencyEnumeration("BSD"); + + // + public static final CurrencyEnumeration BTN = new CurrencyEnumeration("BTN"); + + // + public static final CurrencyEnumeration BWP = new CurrencyEnumeration("BWP"); + + // + public static final CurrencyEnumeration BYR = new CurrencyEnumeration("BYR"); + + // + public static final CurrencyEnumeration BZD = new CurrencyEnumeration("BZD"); + + // + public static final CurrencyEnumeration CAD = new CurrencyEnumeration("CAD"); + + // + public static final CurrencyEnumeration CDF = new CurrencyEnumeration("CDF"); + + // + public static final CurrencyEnumeration CHF = new CurrencyEnumeration("CHF"); + + // + public static final CurrencyEnumeration CLP = new CurrencyEnumeration("CLP"); + + // + public static final CurrencyEnumeration CNY = new CurrencyEnumeration("CNY"); + + // + public static final CurrencyEnumeration CRC = new CurrencyEnumeration("CRC"); + + // + public static final CurrencyEnumeration CSD = new CurrencyEnumeration("CSD"); + + // + public static final CurrencyEnumeration CUP = new CurrencyEnumeration("CUP"); + + // + public static final CurrencyEnumeration CVE = new CurrencyEnumeration("CVE"); + + // + public static final CurrencyEnumeration CYP = new CurrencyEnumeration("CYP"); + + // + public static final CurrencyEnumeration CZK = new CurrencyEnumeration("CZK"); + + // + public static final CurrencyEnumeration DJF = new CurrencyEnumeration("DJF"); + + // + public static final CurrencyEnumeration DKK = new CurrencyEnumeration("DKK"); + + // + public static final CurrencyEnumeration DOP = new CurrencyEnumeration("DOP"); + + // + public static final CurrencyEnumeration DZD = new CurrencyEnumeration("DZD"); + + // + public static final CurrencyEnumeration EEK = new CurrencyEnumeration("EEK"); + + // + public static final CurrencyEnumeration EGP = new CurrencyEnumeration("EGP"); + + // + public static final CurrencyEnumeration ERN = new CurrencyEnumeration("ERN"); + + // + public static final CurrencyEnumeration ETB = new CurrencyEnumeration("ETB"); + + // + public static final CurrencyEnumeration EUR = new CurrencyEnumeration("EUR"); + + // + public static final CurrencyEnumeration FJD = new CurrencyEnumeration("FJD"); + + // + public static final CurrencyEnumeration FKP = new CurrencyEnumeration("FKP"); + + // + public static final CurrencyEnumeration GBP = new CurrencyEnumeration("GBP"); + + // + public static final CurrencyEnumeration GEL = new CurrencyEnumeration("GEL"); + + // + public static final CurrencyEnumeration GGP = new CurrencyEnumeration("GGP"); + + // + public static final CurrencyEnumeration GHC = new CurrencyEnumeration("GHC"); + + // + public static final CurrencyEnumeration GIP = new CurrencyEnumeration("GIP"); + + // + public static final CurrencyEnumeration GMD = new CurrencyEnumeration("GMD"); + + // + public static final CurrencyEnumeration GNF = new CurrencyEnumeration("GNF"); + + // + public static final CurrencyEnumeration GTQ = new CurrencyEnumeration("GTQ"); + + // + public static final CurrencyEnumeration GYD = new CurrencyEnumeration("GYD"); + + // + public static final CurrencyEnumeration HKD = new CurrencyEnumeration("HKD"); + + // + public static final CurrencyEnumeration HNL = new CurrencyEnumeration("HNL"); + + // + public static final CurrencyEnumeration HRK = new CurrencyEnumeration("HRK"); + + // + public static final CurrencyEnumeration HTG = new CurrencyEnumeration("HTG"); + + // + public static final CurrencyEnumeration HUF = new CurrencyEnumeration("HUF"); + + // + public static final CurrencyEnumeration IDR = new CurrencyEnumeration("IDR"); + + // + public static final CurrencyEnumeration ILS = new CurrencyEnumeration("ILS"); + + // + public static final CurrencyEnumeration IMP = new CurrencyEnumeration("IMP"); + + // + public static final CurrencyEnumeration INR = new CurrencyEnumeration("INR"); + + // + public static final CurrencyEnumeration IQD = new CurrencyEnumeration("IQD"); + + // + public static final CurrencyEnumeration IRR = new CurrencyEnumeration("IRR"); + + // + public static final CurrencyEnumeration ISK = new CurrencyEnumeration("ISK"); + + // + public static final CurrencyEnumeration JEP = new CurrencyEnumeration("JEP"); + + // + public static final CurrencyEnumeration JMD = new CurrencyEnumeration("JMD"); + + // + public static final CurrencyEnumeration JOD = new CurrencyEnumeration("JOD"); + + // + public static final CurrencyEnumeration JPY = new CurrencyEnumeration("JPY"); + + // + public static final CurrencyEnumeration KES = new CurrencyEnumeration("KES"); + + // + public static final CurrencyEnumeration KGS = new CurrencyEnumeration("KGS"); + + // + public static final CurrencyEnumeration KHR = new CurrencyEnumeration("KHR"); + + // + public static final CurrencyEnumeration KMF = new CurrencyEnumeration("KMF"); + + // + public static final CurrencyEnumeration KPW = new CurrencyEnumeration("KPW"); + + // + public static final CurrencyEnumeration KRW = new CurrencyEnumeration("KRW"); + + // + public static final CurrencyEnumeration KWD = new CurrencyEnumeration("KWD"); + + // + public static final CurrencyEnumeration KYD = new CurrencyEnumeration("KYD"); + + // + public static final CurrencyEnumeration KZT = new CurrencyEnumeration("KZT"); + + // + public static final CurrencyEnumeration LAK = new CurrencyEnumeration("LAK"); + + // + public static final CurrencyEnumeration LBP = new CurrencyEnumeration("LBP"); + + // + public static final CurrencyEnumeration LKR = new CurrencyEnumeration("LKR"); + + // + public static final CurrencyEnumeration LRD = new CurrencyEnumeration("LRD"); + + // + public static final CurrencyEnumeration LSL = new CurrencyEnumeration("LSL"); + + // + public static final CurrencyEnumeration LTL = new CurrencyEnumeration("LTL"); + + // + public static final CurrencyEnumeration LVL = new CurrencyEnumeration("LVL"); + + // + public static final CurrencyEnumeration LYD = new CurrencyEnumeration("LYD"); + + // + public static final CurrencyEnumeration MAD = new CurrencyEnumeration("MAD"); + + // + public static final CurrencyEnumeration MDL = new CurrencyEnumeration("MDL"); + + // + public static final CurrencyEnumeration MGA = new CurrencyEnumeration("MGA"); + + // + public static final CurrencyEnumeration MKD = new CurrencyEnumeration("MKD"); + + // + public static final CurrencyEnumeration MMK = new CurrencyEnumeration("MMK"); + + // + public static final CurrencyEnumeration MNT = new CurrencyEnumeration("MNT"); + + // + public static final CurrencyEnumeration MOP = new CurrencyEnumeration("MOP"); + + // + public static final CurrencyEnumeration MRO = new CurrencyEnumeration("MRO"); + + // + public static final CurrencyEnumeration MTL = new CurrencyEnumeration("MTL"); + + // + public static final CurrencyEnumeration MUR = new CurrencyEnumeration("MUR"); + + // + public static final CurrencyEnumeration MVR = new CurrencyEnumeration("MVR"); + + // + public static final CurrencyEnumeration MWK = new CurrencyEnumeration("MWK"); + + // + public static final CurrencyEnumeration MXN = new CurrencyEnumeration("MXN"); + + // + public static final CurrencyEnumeration MYR = new CurrencyEnumeration("MYR"); + + // + public static final CurrencyEnumeration MZM = new CurrencyEnumeration("MZM"); + + // + public static final CurrencyEnumeration NAD = new CurrencyEnumeration("NAD"); + + // + public static final CurrencyEnumeration NGN = new CurrencyEnumeration("NGN"); + + // + public static final CurrencyEnumeration NIO = new CurrencyEnumeration("NIO"); + + // + public static final CurrencyEnumeration NOK = new CurrencyEnumeration("NOK"); + + // + public static final CurrencyEnumeration NPR = new CurrencyEnumeration("NPR"); + + // + public static final CurrencyEnumeration NZD = new CurrencyEnumeration("NZD"); + + // + public static final CurrencyEnumeration OMR = new CurrencyEnumeration("OMR"); + + // + public static final CurrencyEnumeration PAB = new CurrencyEnumeration("PAB"); + + // + public static final CurrencyEnumeration PEN = new CurrencyEnumeration("PEN"); + + // + public static final CurrencyEnumeration PGK = new CurrencyEnumeration("PGK"); + + // + public static final CurrencyEnumeration PHP = new CurrencyEnumeration("PHP"); + + // + public static final CurrencyEnumeration PKR = new CurrencyEnumeration("PKR"); + + // + public static final CurrencyEnumeration PLN = new CurrencyEnumeration("PLN"); + + // + public static final CurrencyEnumeration PYG = new CurrencyEnumeration("PYG"); + + // + public static final CurrencyEnumeration QAR = new CurrencyEnumeration("QAR"); + + // + public static final CurrencyEnumeration RON = new CurrencyEnumeration("RON"); + + // + public static final CurrencyEnumeration RUB = new CurrencyEnumeration("RUB"); + + // + public static final CurrencyEnumeration RWF = new CurrencyEnumeration("MOP"); + + // + public static final CurrencyEnumeration SAR = new CurrencyEnumeration("SAR"); + + // + public static final CurrencyEnumeration SBD = new CurrencyEnumeration("SBD"); + + // + public static final CurrencyEnumeration SCR = new CurrencyEnumeration("SCR"); + + // + public static final CurrencyEnumeration SDD = new CurrencyEnumeration("SDD"); + + // + public static final CurrencyEnumeration SEK = new CurrencyEnumeration("SEK"); + + // + public static final CurrencyEnumeration SGD = new CurrencyEnumeration("SGD"); + + // + public static final CurrencyEnumeration SHP = new CurrencyEnumeration("SHP"); + + // + public static final CurrencyEnumeration SIT = new CurrencyEnumeration("SIT"); + + // + public static final CurrencyEnumeration SKK = new CurrencyEnumeration("SKK"); + + // + public static final CurrencyEnumeration SLL = new CurrencyEnumeration("SLL"); + + // + public static final CurrencyEnumeration SOS = new CurrencyEnumeration("SOS"); + + // + public static final CurrencyEnumeration SPL = new CurrencyEnumeration("SPL"); + + // + public static final CurrencyEnumeration SRD = new CurrencyEnumeration("SRD"); + + // + public static final CurrencyEnumeration STD = new CurrencyEnumeration("STD"); + + // + public static final CurrencyEnumeration SVC = new CurrencyEnumeration("SVC"); + + // + public static final CurrencyEnumeration SYP = new CurrencyEnumeration("SYP"); + + // + public static final CurrencyEnumeration SZL = new CurrencyEnumeration("SZL"); + + // + public static final CurrencyEnumeration THB = new CurrencyEnumeration("THB"); + + // + public static final CurrencyEnumeration TJS = new CurrencyEnumeration("TJS"); + + // + public static final CurrencyEnumeration TMM = new CurrencyEnumeration("TMM"); + + // + public static final CurrencyEnumeration TND = new CurrencyEnumeration("TND"); + + // + public static final CurrencyEnumeration TOP = new CurrencyEnumeration("TOP"); + + // + public static final CurrencyEnumeration TRL = new CurrencyEnumeration("TRL"); + + // + public static final CurrencyEnumeration TRY = new CurrencyEnumeration("TRY"); + + // + public static final CurrencyEnumeration TTD = new CurrencyEnumeration("TTD"); + + // + public static final CurrencyEnumeration TVD = new CurrencyEnumeration("TVD"); + + // + public static final CurrencyEnumeration TWD = new CurrencyEnumeration("TWD"); + + // + public static final CurrencyEnumeration TZS = new CurrencyEnumeration("TZS"); + + // + public static final CurrencyEnumeration UAH = new CurrencyEnumeration("UAH"); + + // + public static final CurrencyEnumeration UGX = new CurrencyEnumeration("UGX"); + + // + public static final CurrencyEnumeration USD = new CurrencyEnumeration("USD"); + + // + public static final CurrencyEnumeration UYU = new CurrencyEnumeration("UYU"); + + // + public static final CurrencyEnumeration UZS = new CurrencyEnumeration("UZS"); + + // + public static final CurrencyEnumeration VEB = new CurrencyEnumeration("VEB"); + + // + public static final CurrencyEnumeration VND = new CurrencyEnumeration("VND"); + + // + public static final CurrencyEnumeration VUV = new CurrencyEnumeration("VUV"); + + // + public static final CurrencyEnumeration WST = new CurrencyEnumeration("WST"); + + // + public static final CurrencyEnumeration XAF = new CurrencyEnumeration("XAF"); + + // + public static final CurrencyEnumeration XAG = new CurrencyEnumeration("XAG"); + + // + public static final CurrencyEnumeration XAU = new CurrencyEnumeration("XAU"); + + // + public static final CurrencyEnumeration XCD = new CurrencyEnumeration("XCD"); + + // + public static final CurrencyEnumeration XDR = new CurrencyEnumeration("XDR"); + + // + public static final CurrencyEnumeration XOF = new CurrencyEnumeration("XOF"); + + // + public static final CurrencyEnumeration XPD = new CurrencyEnumeration("XPD"); + + // + public static final CurrencyEnumeration XPF = new CurrencyEnumeration("XPF"); + + // + public static final CurrencyEnumeration XPT = new CurrencyEnumeration("XPT"); + + // + public static final CurrencyEnumeration YER = new CurrencyEnumeration("YER"); + + // + public static final CurrencyEnumeration ZAR = new CurrencyEnumeration("ZAR"); + + // + public static final CurrencyEnumeration ZMK = new CurrencyEnumeration("ZMK"); + + // + public static final CurrencyEnumeration ZWD = new CurrencyEnumeration("ZWD"); + + // + private String value; + + /** + * Creates a new instance of CurrencyEnumeration + * + * @param value DOCUMENT ME! + */ + private CurrencyEnumeration(String value) { + this.value = value; + lookup.put(value,this); + } + + public String getValue() { + return this.value; + } + + public Object clone() { + return this; + } + + public static CurrencyEnumeration findByValue(String value) { + return (CurrencyEnumeration)lookup.get(value.trim().toUpperCase()); + } + + public String toString() { + return value; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/types/DateTimeRange.java b/src/main/java/com/sun/syndication/feed/module/base/types/DateTimeRange.java new file mode 100644 index 0000000..70dde03 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/types/DateTimeRange.java @@ -0,0 +1,127 @@ +/* + * DateTimeRange.java + * + * Created on November 16, 2005, 11:14 AM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base.types; + +import java.util.Date; + + +/** Represents a time range. + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.2 $ + */ +public class DateTimeRange implements CloneableType { + /** + * end time + */ + private Date end; + /** + * start time + */ + private Date start; + + /** + * Creates a new instance of DateTimeRange + * @param start Beginning of the timeframe. + * @param end End of the Timeframe. + */ + public DateTimeRange(Date start, Date end) { + this.start= start; + this.end = end ; + } + + + /** + * The end of the timeframe. + * @return The end of the timeframe. + */ + public Date getEnd() { + return end; + } + + + /** + * The beginning of the timeframe. + * @return The beginning of the timeframe. + */ + public Date getStart() { + return start; + } + + /** + * Clones the object + * @return Duplicate of this object. + */ + public Object clone() { + DateTimeRange retValue = new DateTimeRange(null, null); + + if (this.getStart() != null) { + retValue.start = ((Date) this.getStart().clone()); + } + + if (this.getEnd() != null) { + retValue.end = ((Date) this.getEnd().clone()); + } + + return retValue; + } + + /** + * String representation of the object. + * @return String representation of the object. + */ + public String toString() { + return "Start: " + this.start + " End: " + this.end; + } + + public boolean equals( Object o ){ + if( !(o instanceof DateTimeRange ) || o == null ) + return false; + DateTimeRange d = (DateTimeRange) o; + if( this.start == d.getStart() && this.end == d.getEnd() ){ + return true; + } + if( this.start != null && !this.start.equals( d.getStart()) ) + return false; + if( this.end != null && !this.end.equals( d.getEnd()) ) + return false; + return true; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/types/FloatUnit.java b/src/main/java/com/sun/syndication/feed/module/base/types/FloatUnit.java new file mode 100644 index 0000000..2360973 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/types/FloatUnit.java @@ -0,0 +1,159 @@ +/* + * FloatUnit.java + * + * Created on November 16, 2005, 11:43 AM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base.types; + +import com.sun.syndication.feed.module.base.io.GoogleBaseParser; + + +/** This class represents a quantity consisting of a float value and an optional + * units specification. + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public class FloatUnit implements CloneableType { + /** + * Units + */ + private String units; + /** + * Float value + */ + private float value; + + /** + * Looks for a char in an array + * @param find char to search for + * @param array array to search + * @return boolean indicating presence. + */ + private boolean inCharArray( char find, char[] array ){ + for( int i=0; i < array.length; i++ ){ + if( find == array[i]) + return true; + } + return false; + } + + /** + * Creates a new float unit by parsing a String value + * @param source String value to parse + */ + public FloatUnit(String source) { + String parse = source.trim(); + int space = -1; + for( int i=0; i < parse.length(); i++ ){ + if( !inCharArray( parse.charAt(i), GoogleBaseParser.FLOAT_CHARS ) ){ + space = i; + break; + } + } + + if (space == -1) { + space = parse.length(); + } + + this.value = Float.parseFloat( + GoogleBaseParser.stripNonValidCharacters(GoogleBaseParser.FLOAT_CHARS, parse.substring(0, space))); + + if (space != parse.length()) { + this.units = parse.substring(space, parse.length()).trim(); + } + } + + /** + * Creates a new instance of FloatUnit + * @param value float value + * @param units Units represented, or null. + */ + public FloatUnit(float value, String units) { + this.value = value; + this.units = units; + } + + /** + * Returns the units. + * @return Returns the units. + */ + public String getUnits() { + return units; + } + + /** + * Returns the float value. + * @return Returns the float value. + */ + public float getValue() { + return value; + } + + /** + * Duplicates the object. + * @return Duplicate FloatUnit + */ + public Object clone() { + return new FloatUnit(0 + this.value, this.units); + } + + /** + * Returns a String representation of the object. + * @return Returns a String representation of the object. + */ + public String toString() { + if ((this.units != null) && (this.units.trim().length() > 0)) { + return this.value + " " + this.units; + } else { + return Float.toString(value); + } + } + + public boolean equals( Object o ){ + if(!(o instanceof FloatUnit) ) + return false; + FloatUnit f = (FloatUnit) o; + if( f.getValue() != this.value ){ + return false; + } + if( this.units == f.getUnits() || ( this.units != null && this.units.equals( f.getUnits() )) ){ + return true; + } + return false; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/types/GenderEnumeration.java b/src/main/java/com/sun/syndication/feed/module/base/types/GenderEnumeration.java new file mode 100644 index 0000000..db61c57 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/types/GenderEnumeration.java @@ -0,0 +1,88 @@ +/* + * GenderEnumeration.java + * + * Created on November 16, 2005, 2:35 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base.types; + +/** Simple enumeration for Genders. + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public class GenderEnumeration implements CloneableType { + /** Men */ + public static final GenderEnumeration MALE = new GenderEnumeration("Male"); + /** Women */ + public static final GenderEnumeration FEMALE = new GenderEnumeration("Female"); + private String value; + + private GenderEnumeration(String value) { + this.value = value; + } + + /** Returns the proper instance based on the string value */ + public static GenderEnumeration findByValue(String value) { + if (value == null) { + return null; + } + + String gender = value.toUpperCase(); + + if (gender.charAt(0) == 'M') { + return GenderEnumeration.MALE; + } else if (gender.charAt(0) == 'F') { + return GenderEnumeration.FEMALE; + } else { + return null; + } + } + + /** Returns the value of the instance */ + public String getValue() { + return this.value; + } + + /** Returns a reference to the same object. :P */ + public Object clone() { + return this; + } + + public String toString() { + return value; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/types/IntUnit.java b/src/main/java/com/sun/syndication/feed/module/base/types/IntUnit.java new file mode 100644 index 0000000..0f9243a --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/types/IntUnit.java @@ -0,0 +1,119 @@ +/* + * IntUnit.java + * + * Created on November 16, 2005, 12:49 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base.types; + +import com.sun.syndication.feed.module.base.io.GoogleBaseParser; + + +/** + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public class IntUnit implements CloneableType { + private String units; + private int value; + private boolean inCharArray( char find, char[] array ){ + for( int i=0; i < array.length; i++ ){ + if( find == array[i]) + return true; + } + return false; + } + public IntUnit(String source) { + String parse = source.trim(); + int space = -1; + for( int i=0; i < parse.length(); i++ ){ + if( !inCharArray( parse.charAt(i), GoogleBaseParser.INTEGER_CHARS ) ){ + space = i; + break; + } + } + if (space == -1) { + space = parse.length(); + } + + this.value = Integer.parseInt( + GoogleBaseParser.stripNonValidCharacters(GoogleBaseParser.INTEGER_CHARS, parse.substring(0, space))); + + if (space != parse.length()) { + this.units = parse.substring(space, parse.length()).trim(); + } + } + + /** Creates a new instance of IntUnit */ + public IntUnit(int value, String units) { + this.value = value; + this.units = units; + } + + public String getUnits() { + return units; + } + + public int getValue() { + return value; + } + + public Object clone() { + return new IntUnit(this.value, this.units); + } + + public String toString() { + if ((this.units != null) && (this.units.trim().length() > 0)) { + return this.value + " " + this.units; + } else { + return Integer.toString(value); + } + } + + public boolean equals( Object o ){ + if(!(o instanceof IntUnit) ) + return false; + IntUnit f = (IntUnit) o; + if( f.getValue() != this.value ){ + return false; + } + if( this.units == f.getUnits() || ( this.units != null && this.units.equals( f.getUnits() )) ){ + return true; + } + return false; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/types/PaymentTypeEnumeration.java b/src/main/java/com/sun/syndication/feed/module/base/types/PaymentTypeEnumeration.java new file mode 100644 index 0000000..62e9166 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/types/PaymentTypeEnumeration.java @@ -0,0 +1,83 @@ +/* + * PaymentTypeEnumeration.java + * + * Created on November 16, 2005, 11:49 AM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base.types; + +import java.util.HashMap; + +/** + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public class PaymentTypeEnumeration { + private static final HashMap lookup = new HashMap(); + public static final PaymentTypeEnumeration CASH = new PaymentTypeEnumeration("Cash"); + public static final PaymentTypeEnumeration CHECK = new PaymentTypeEnumeration("Check"); + public static final PaymentTypeEnumeration TRAVELERS_CHECK = new PaymentTypeEnumeration("Traveler�s Check"); + public static final PaymentTypeEnumeration VISA = new PaymentTypeEnumeration("Visa"); + public static final PaymentTypeEnumeration MASTERCARD = new PaymentTypeEnumeration("MasterCard"); + public static final PaymentTypeEnumeration AMERICAN_EXPRESS = new PaymentTypeEnumeration("American Express"); + public static final PaymentTypeEnumeration DISCOVER = new PaymentTypeEnumeration("Discover"); + public static final PaymentTypeEnumeration WIRE_TRANSFER = new PaymentTypeEnumeration("Wire transfer"); + public static final PaymentTypeEnumeration PAYPAL = new PaymentTypeEnumeration("Paypal"); + private String value; + + /** Creates a new instance of PaymentTypeEnumeration */ + private PaymentTypeEnumeration(String value) { + this.value = value; + lookup.put(this.value.toUpperCase(), this); + } + + public String getValue() { + return value; + } + + public static PaymentTypeEnumeration findByValue(String value) { + return (PaymentTypeEnumeration) lookup.get(value.toUpperCase()); + } + + public Object clone() { + return this; + } + + public String toString() { + return value; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/types/PriceTypeEnumeration.java b/src/main/java/com/sun/syndication/feed/module/base/types/PriceTypeEnumeration.java new file mode 100644 index 0000000..800f6d4 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/types/PriceTypeEnumeration.java @@ -0,0 +1,107 @@ +/* + * PriceTypeEnumeration.java + * + * Created on November 16, 2005, 11:45 AM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base.types; + + + +/** + * Enumeration of values suitable for "price_type" or "salary_type". + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public class PriceTypeEnumeration implements CloneableType { + /** + * Indicates the value is a starting value. + */ + public static final PriceTypeEnumeration STARTING = new PriceTypeEnumeration("starting"); + /** + * Indicates the value is negotiable + */ + public static final PriceTypeEnumeration NEGOTIABLE = new PriceTypeEnumeration("negotiable"); + /** + * String value encapsulated + */ + private String value; + + /** + * Creates a new instance of PriceTypeEnumeration + * @param value Value to encapsulate + */ + private PriceTypeEnumeration(String value) { + this.value = value; + } + + /** + * Returns the string value of this instance. + * @return Returns the string value of this instance. + */ + public String getValue() { + return value; + } + + /** + * Returns a PriceTypeEnumeration based on the String value or null. + * @param value Value to search for. + * @return PriceTypeEnumeration or null. + */ + public static PriceTypeEnumeration findByValue(String value) { + if (value.equalsIgnoreCase("negotiable")) { + return PriceTypeEnumeration.NEGOTIABLE; + } else { + return PriceTypeEnumeration.STARTING; + } + } + + /** + * Returns a duplicate of this instance + * @return The same instance. + */ + public Object clone() { + return this; + } + + /** + * Returns the string value of this instance. + * @return Returns the string value of this instance. + */ + public String toString() { + return value; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/types/ShippingType.java b/src/main/java/com/sun/syndication/feed/module/base/types/ShippingType.java new file mode 100644 index 0000000..27e8338 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/types/ShippingType.java @@ -0,0 +1,182 @@ +/* + * ShippingType.java + * + * Created on November 16, 2005, 12:05 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base.types; + +import java.util.HashMap; + +/** + * This class represents a specific shipping option for an item. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public class ShippingType implements CloneableType { + /** + * price of the shipping. + */ + private FloatUnit price; + /** + * Service used. + */ + private ServiceEnumeration service; + /** + * Country to ship to + */ + private String country; + + /** + * Creates a new instance of ShippingType + * @param price The price of the shipping option + * @param service Shipping service used. + * @param country Country shipped to. + */ + public ShippingType(FloatUnit price, ServiceEnumeration service, String country) { + this.price = price; + this.service = service; + this.country = country; + } + + /** + * Returns the destination country. + * @return Returns the destination country. + */ + public String getCountry() { + return country; + } + + /** + * Returns the price of this shipping option. + * @return Returns the price of this shipping option. + */ + public FloatUnit getPrice() { + return price; + } + + /** + * Returns the ServiceEnumeration instance for the shipping service used. + * @return Returns the ServiceEnumeration instance for the shipping service used. + */ + public ServiceEnumeration getService() { + return service; + } + + /** + * Clones this object. + * @return Duplicate ShippingType object. + */ + public Object clone() { + return new ShippingType(this.price, this.service, this.country); + } + + /** + * Returns a String representation of this object. + * @return String representation of this object. + */ + public String toString() { + return this.country + " " + this.price + " " + this.service; + } + + public boolean equals( Object o ){ + if( !(o instanceof ShippingType)) + return false; + if( this.toString().equals( o.toString() ) ) + return true; + return false; + } + /** + * Enumeration class of valid options for ServiceType. + */ + public static class ServiceEnumeration { + /** + * Looks up a ServiceEnumeration based on the string value. + */ + private static final HashMap lookup = new HashMap(); + /** + * Standard + */ + public static final ServiceEnumeration STANDARD = new ServiceEnumeration("Standard"); + /** + * Freight + */ + public static final ServiceEnumeration FREIGHT = new ServiceEnumeration("Freight"); + /** + * Overnight + */ + public static final ServiceEnumeration OVERNIGHT = new ServiceEnumeration("Overnight"); + + /** + * String value + */ + private String value; + + /** + * Creates a new instance of ServiceEnumeration. + * @param value String value to encapsulate. + */ + private ServiceEnumeration(String value) { + this.value = value; + lookup.put(this.value.toUpperCase(), this); + } + + /** + * String value of this Service. + * @return String value of this Service. + */ + public String getValue() { + return this.value; + } + + /** + * Looks up a ServiceEnumeration based on the string value. + * @param value String value to search for. + * @return ServiceEnumeration or null. + */ + public static ServiceEnumeration findByValue(String value) { + return (ServiceEnumeration) lookup.get(value.toUpperCase()); + } + + /** + * String value of this Service. + * @return String value of this Service. + */ + public String toString() { + return this.value; + } + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/types/ShortDate.java b/src/main/java/com/sun/syndication/feed/module/base/types/ShortDate.java new file mode 100644 index 0000000..050c96e --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/types/ShortDate.java @@ -0,0 +1,83 @@ +/* + * ShortDate.java + * + * Created on November 17, 2005, 1:04 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.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. + * + * Move along. Nothing to see here. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public class ShortDate extends Date implements CloneableType { + /** Creates a new instance of ShortDate */ + public ShortDate() { + super(); + } + + /** + * Creates a new Short Date based on a Date value. + * @param date Date value to read from. + */ + public ShortDate(Date date) { + super(date.getTime()); + } + + /** + * Creates a new ShortDate based on a millisecond time. + * @param time Millisecond time to start with. + */ + public ShortDate(long time) { + super(time); + } + + /** + * Returns a duplicate of this object. + * @return Duplicate of the object. + */ + public Object clone() { + return new ShortDate(this.getTime()); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/types/Size.java b/src/main/java/com/sun/syndication/feed/module/base/types/Size.java new file mode 100644 index 0000000..718401d --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/types/Size.java @@ -0,0 +1,154 @@ +/* + * Size.java + * + * Created on November 16, 2005, 1:51 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base.types; + +import java.util.StringTokenizer; + + +/** Represents the size on an item in 2 or 3 dimensions. + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.2 $ + */ +public class Size implements CloneableType { + /** + * height + */ + private FloatUnit height; + /** + * length + */ + private FloatUnit length; + /** + * width + */ + private FloatUnit width; + + /** + * Creates a new Size object parsing a string value. + * @param source String value to parse + */ + public Size(String source) { + StringTokenizer tok = new StringTokenizer(source, "Xx"); + this.length = new FloatUnit( tok.nextToken()); + this.width = new FloatUnit( tok.nextToken()); + + if (tok.hasMoreTokens()) { + this.height = new FloatUnit( tok.nextToken()); + } + } + + /** + * Creates a new instance of Size + * @param length lenght value + * @param width width value + */ + public Size(FloatUnit length, FloatUnit width) { + this.length = length; + this.width = width; + } + + /** + * Creates a new instance of Size. + * @param length Length value. + * @param width Width value. + * @param height Height value. + */ + public Size(FloatUnit length, FloatUnit width, FloatUnit height) { + this.length = length; + this.width = width; + this.height = height; + } + + /** + * Height value. + * @return Height value. + */ + public FloatUnit getHeight() { + return height; + } + + /** + * Length value. + * @return Length value. + */ + public FloatUnit getLength() { + return length; + } + + /** + * Width value. + * @return Width value. + */ + public FloatUnit getWidth() { + return width; + } + + /** + * Duplicates this object. + * @return A duplicate Size object. + */ + public Object clone() { + if (this.height != null) { + return new Size(this.length, this.width, this.height); + } else { + return new Size(this.length, this.width); + } + } + + /** + * Returns a string representation of this object. + * @return A string representation of this object. + */ + public String toString() { + if (height != null) { + return length + "x" + width + "x" + height; + } else { + return length + "x" + width; + } + } + public boolean equals( Object o ){ + if( !(o instanceof Size)) + return false; + if( this.toString().equals( o.toString() ) ) + return true; + return false; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/types/YearType.java b/src/main/java/com/sun/syndication/feed/module/base/types/YearType.java new file mode 100644 index 0000000..8f063e7 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/types/YearType.java @@ -0,0 +1,98 @@ +/* + * YearType.java + * + * Created on November 17, 2005, 11:42 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.base.types; + +import java.util.Calendar; +import java.util.Date; + + +/** This class represents a simple 4 digit year. + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.1 $ + */ +public class YearType implements CloneableType { + /** + * year value + */ + int year; + + /** + * Creates a new year from a string value. + * @param year String to parse. + */ + public YearType(String year) { + this.year = Integer.parseInt(year.trim()); + } + + /** + * Creates a new instance of YearType + * @param date Date to get the year from. + */ + public YearType(Date date) { + Calendar cal = Calendar.getInstance(); + cal.setTime(date); + this.year = cal.get( Calendar.YEAR ); + } + + /** + * Duplicates this object. + * @return Cloned Year. + */ + public Object clone() { + return new YearType(Integer.toString(this.year)); + } + + /** + * Returns a String representation of this object. + * @return Returns a String representation of this object. + */ + public String toString() { + return Integer.toString(year); + } + + public boolean equals( Object o ){ + if( !(o instanceof YearType)) + return false; + if( this.toString().equals( o.toString() ) ) + return true; + return false; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/base/types/package.html b/src/main/java/com/sun/syndication/feed/module/base/types/package.html new file mode 100644 index 0000000..618ff0c --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/base/types/package.html @@ -0,0 +1,45 @@ + + + + + + + + This package contains complex and utility datatypes for use with Google Base. + 
+ * This library is provided under dual licenses. 
+ * You may choose the terms of the Lesser General Public License or the Apache
+ * License at your discretion.
+ *
+ *  Copyright (C) 2005  Robert Cooper, Temple of the Screaming Penguin
+ *
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.   
+
+ + diff --git a/src/main/java/com/sun/syndication/feed/module/cc/CreativeCommons.java b/src/main/java/com/sun/syndication/feed/module/cc/CreativeCommons.java new file mode 100644 index 0000000..bac9870 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/cc/CreativeCommons.java @@ -0,0 +1,59 @@ +/* + * CreativeCommons.java + * + * Created on November 20, 2005, 5:05 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.sun.syndication.feed.module.cc; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.feed.module.cc.types.License; + +/** + * + * @author Robert "kebernet" Cooper + */ +public interface CreativeCommons extends Module { + + public static final String URI = "rome:CreativeCommons"; + + public License[] getAllLicenses(); + public void setAllLicenses(License[] licenses); + + public License[] getLicenses(); + public void setLicenses(License[] license ); +} diff --git a/src/main/java/com/sun/syndication/feed/module/cc/CreativeCommonsImpl.java b/src/main/java/com/sun/syndication/feed/module/cc/CreativeCommonsImpl.java new file mode 100644 index 0000000..9d85d4d --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/cc/CreativeCommonsImpl.java @@ -0,0 +1,124 @@ +/* + * AbstractCreativeCommons.java + * + * Created on November 20, 2005, 5:12 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.sun.syndication.feed.module.cc; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; +import com.sun.syndication.feed.module.cc.types.License; +import java.lang.reflect.Array; + +/** + * @version $Revision: 1.1 $ + * @author Robert "kebernet" Cooper + */ +public class CreativeCommonsImpl implements CreativeCommons { + + public static final String RDF_URI = "http://www.w3.org/1999/02/22-rdf-syntax-ns#"; + public static final String RSS2_URI ="http://backend.userland.com/creativeCommonsRssModule"; + public static final String RSS1_URI = "http://web.resource.org/cc/"; + + private License[] allLicenses; + private License[] licenses; + + protected Object arrayCopy(Object[] source) { + if(source == null) { + return null; + } + + Object[] array = (Object[])Array.newInstance(source.getClass().getComponentType(),source.length); + + for(int i = 0; i < source.length; i++) { + array[i] = source[i]; + } + + return array; + } + + public License[] getAllLicenses() { + return allLicenses; + } + + public void setAllLicenses(License[] allLicenses) { + this.allLicenses = allLicenses; + } + + public Class getInterface() { + return CreativeCommons.class; + } + + + public String getUri() { + return CreativeCommons.URI; + } + + public Object clone() { + CreativeCommonsImpl clone = new CreativeCommonsImpl(); + clone.copyFrom( this ); + return clone; + } + + public void copyFrom(Object object) { + CreativeCommons source = (CreativeCommons) object; + this.setAllLicenses( (License[]) arrayCopy( source.getAllLicenses() )); + this.setLicenses( source.getLicenses() ); + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(this.getClass(),this); + + return eBean.beanEquals(obj); + } + + + public License[] getLicenses() { + return licenses; + } + + public void setLicenses(License[] licenses) { + this.licenses = licenses; + } + + public String toString() { + + ToStringBean tsb = new ToStringBean( CreativeCommonsImpl.class, this ); + return tsb.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/cc/io/CCModuleGenerator.java b/src/main/java/com/sun/syndication/feed/module/cc/io/CCModuleGenerator.java new file mode 100644 index 0000000..be0d18f --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/cc/io/CCModuleGenerator.java @@ -0,0 +1,142 @@ +/* + * CCModuleGenerator.java + * + * Created on November 20, 2005, 5:23 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.sun.syndication.feed.module.cc.io; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.io.ModuleGenerator; +import com.sun.syndication.feed.module.cc.CreativeCommons; +import com.sun.syndication.feed.module.cc.CreativeCommonsImpl; +import com.sun.syndication.feed.module.cc.types.License; +import java.util.HashSet; +import java.util.Set; +import org.jdom.Element; +import org.jdom.Namespace; + +/** + * @version $Revision: 1.1 $ + * @author Robert "kebernet" Cooper + */ +public class CCModuleGenerator implements ModuleGenerator{ + + private static final Namespace RSS1 = Namespace.getNamespace( "cc", CreativeCommonsImpl.RSS1_URI ); + private static final Namespace RSS2 = Namespace.getNamespace( "creativeCommons", CreativeCommonsImpl.RSS2_URI); + private static final Namespace RSS = Namespace.getNamespace("http://purl.org/rss/1.0/"); + private static final Namespace RDF = Namespace.getNamespace("rdf", "http://www.w3.org/1999/02/22-rdf-syntax-ns#"); + private static final HashSet NAMESPACES = new HashSet(); + static{ + NAMESPACES.add( RSS1 ); + NAMESPACES.add( RSS2 ); + NAMESPACES.add( RDF ); + } + + /** + * Creates a new instance of CCModuleGenerator + */ + public CCModuleGenerator() { + super(); + } + + public void generate(Module module, Element element) { + Element root = element; + while( root.getParentElement() != null ){ + root = root.getParentElement(); + } + if( root.getNamespace().equals( RDF )|| root.getNamespace().equals( RSS )){ + generateRSS1( (CreativeCommons) module, element); + } else { + generateRSS2( (CreativeCommons) module, element); + } + } + + public Set getNamespaces() { + return NAMESPACES; + } + + public String getNamespaceUri() { + return CreativeCommons.URI; + } + + private void generateRSS1( CreativeCommons module, Element element ){ + //throw new RuntimeException( "Generating RSS1 Feeds not currently Supported."); + + System.out.println(element.getName()); + if( element.getName().equals("channel")){ + // Do all licenses list. + License[] all = module.getAllLicenses(); + for( int i=0; i < all.length ; i++){ + Element license = new Element( "License", RSS1 ); + license.setAttribute( "about", all[i].getValue(), RDF ); + License.Behaviour[] permits = all[i].getPermits(); + for( int j=0; permits != null && j < permits.length; j++ ){ + Element permit = new Element( "permits", RSS1 ); + permit.setAttribute( "resource", permits[j].toString(), RDF); + license.addContent( permit ); + } + License.Behaviour[] requires = all[i].getPermits(); + for( int j=0; requires != null && j < requires.length; j++ ){ + Element permit = new Element( "requires", RSS1 ); + permit.setAttribute( "resource", permits[j].toString(), RDF); + license.addContent( permit ); + } + System.out.println("Is Root?"+element.getParentElement()); + element.getParentElement().addContent( license ); + } + } + + //Do local licenses + License[] licenses = module.getLicenses(); + for( int i=0; i < licenses.length; i++ ){ + Element license = new Element( "license", RSS1 ); + license.setAttribute( "resource", licenses[i].getValue(), RDF); + element.addContent( license ); + } + + } + + private void generateRSS2( CreativeCommons module, Element element ){ + License[] licenses = module.getLicenses(); + for( int i=0; licenses != null && i < licenses.length; i++ ){ + Element license = new Element( "license", RSS2 ); + license.setText( licenses[i].getValue() ); + element.addContent( license ); + } + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/cc/io/ModuleParserRSS1.java b/src/main/java/com/sun/syndication/feed/module/cc/io/ModuleParserRSS1.java new file mode 100644 index 0000000..10a41ff --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/cc/io/ModuleParserRSS1.java @@ -0,0 +1,133 @@ +/* + * CCModuleParser.java + * + * Created on November 20, 2005, 5:23 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.sun.syndication.feed.module.cc.io; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.io.ModuleParser; +import com.sun.syndication.feed.module.cc.CreativeCommonsImpl; +import com.sun.syndication.feed.module.cc.types.License; + +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; +import org.jdom.Element; +import org.jdom.Namespace; + + +/** + * @version $Revision: 1.3 $ + * @author Robert "kebernet" Cooper + */ +public class ModuleParserRSS1 implements ModuleParser { + + private static final Namespace NS = Namespace.getNamespace( CreativeCommonsImpl.RSS1_URI ); + static final Namespace RDF = Namespace.getNamespace( CreativeCommonsImpl.RDF_URI ); + /** + * Creates a new instance of ModuleParserRSS1 + */ + public ModuleParserRSS1() { + } + + public Module parse(Element element) { + CreativeCommonsImpl module = new CreativeCommonsImpl(); + { + // Parsing Channel level. + Element root =element; + while(root.getParentElement() != null ) + root = root.getParentElement(); + List licenseList = root.getChildren( "License", NS ); + ArrayList licenses = new ArrayList(); + Iterator it = licenseList.iterator(); + while( it.hasNext() ){ + Element licenseTag = (Element) it.next(); + String licenseURI = licenseTag.getAttributeValue("about", RDF); + if( licenseURI == null ) + continue; + License license = License.findByValue( licenseURI ); + { + ArrayList permitsValues = new ArrayList(); + ArrayList requiresValues = new ArrayList(); + List permitsTags = licenseTag.getChildren("permits", NS ); + Iterator sit = permitsTags.iterator(); + while(sit.hasNext() ){ + Element permitTag = (Element) sit.next(); + permitsValues.add( License.Behaviour.findByValue( permitTag.getAttributeValue( "resource", RDF) )); + } + List requiresTags = licenseTag.getChildren( "requires", NS); + sit = requiresTags.iterator(); + while(sit.hasNext()){ + Element requireTag = (Element) sit.next(); + requiresValues.add( License.Behaviour.findByValue(requireTag.getAttributeValue("resource", RDF))); + } + license = new License( licenseURI, + (License.Behaviour[]) requiresValues.toArray( new License.Behaviour[requiresValues.size()]), + (License.Behaviour[]) permitsValues.toArray( new License.Behaviour[permitsValues.size()]) ); + + } + + licenses.add( license ); + } + module.setAllLicenses( (License[]) licenses.toArray( new License[0] ) ); + } + ArrayList licenses = new ArrayList(); + List licenseTags = element.getChildren( "license", NS ); + Iterator lit = licenseTags.iterator(); + while( lit.hasNext() ){ + Element licenseTag = (Element) lit.next(); + licenses.add( License.findByValue( licenseTag.getAttributeValue( "resource", RDF))); + } + + if( licenses.size() > 0 ){ + module.setLicenses( (License[]) licenses.toArray( new License[licenses.size()])); + } + + if( module.getLicenses() != null || module.getAllLicenses() != null ){ + return module; + } else { + return null; + } + } + + public String getNamespaceUri() { + return CreativeCommonsImpl.RSS1_URI; + } + +} diff --git a/src/main/java/com/sun/syndication/feed/module/cc/io/ModuleParserRSS2.java b/src/main/java/com/sun/syndication/feed/module/cc/io/ModuleParserRSS2.java new file mode 100644 index 0000000..03174f2 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/cc/io/ModuleParserRSS2.java @@ -0,0 +1,119 @@ +/* + * ModuleParserRSS2.java + * + * Created on November 20, 2005, 6:15 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.sun.syndication.feed.module.cc.io; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.io.ModuleParser; +import com.sun.syndication.feed.module.cc.CreativeCommonsImpl; +import com.sun.syndication.feed.module.cc.types.License; + +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; +import org.jdom.Element; +import org.jdom.Namespace; + +/** + * + * @version $Revision: 1.3 $ + * @author Robert "kebernet" Cooper + */ +public class ModuleParserRSS2 implements ModuleParser { + + private static final Namespace NS = Namespace.getNamespace( CreativeCommonsImpl.RSS2_URI ); + + /** Creates a new instance of ModuleParserRSS2 */ + public ModuleParserRSS2() { + } + + public Module parse(Element element) { + CreativeCommonsImpl module = new CreativeCommonsImpl(); + //Do channel global + { + Element root = element; + while( !root.getName().equals("channel") && !root.getName().equals("feed") ) + root = root.getParentElement(); + ArrayList licenses = new ArrayList(); + List items = null; + if( root.getName().equals("channel")) + items = root.getChildren("item"); + else + items = root.getChildren("entry"); + + Iterator iit = items.iterator(); + while( iit.hasNext() ){ + Element item = (Element) iit.next(); + List licenseTags = item.getChildren( "license", NS ); + Iterator lit = licenseTags.iterator(); + while(lit.hasNext() ){ + Element licenseTag = (Element) lit.next(); + License license = License.findByValue( licenseTag.getTextTrim() ); + if( !licenses.contains( license )); + licenses.add( license ); + } + } + if( licenses.size() > 0 ){ + module.setAllLicenses( (License[]) licenses.toArray( new License[0] ) ); + } + } + // do element local + ArrayList licenses = new ArrayList(); + List licenseTags = element.getChildren( "license", NS ); + Iterator it = licenseTags.iterator(); + while( it.hasNext() ){ + Element licenseTag = (Element) it.next(); + licenses.add( License.findByValue(licenseTag.getTextTrim() )); + } + if( licenses.size() > 0 ){ + module.setLicenses( (License[]) licenses.toArray( new License[0])); + } + + if( module.getLicenses() != null && module.getAllLicenses() != null ){ + return module; + } else { + return null; + } + } + + public String getNamespaceUri() { + return CreativeCommonsImpl.RSS2_URI; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/cc/package.html b/src/main/java/com/sun/syndication/feed/module/cc/package.html new file mode 100644 index 0000000..0a0fbb7 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/cc/package.html @@ -0,0 +1,80 @@ + + + + + + + + This is a module for ROME that supports both the + "CC" RSS1 module and the + RSS 2 (and Atom) + module in a unified manner. + +

It does this by superimposing the "rome:creativecommon" namespace over both of them + for the purposes of the module, and synchronizes them into a unified structure. For RSS2 + it attempts to correlate the license into a code-capable fashion. If the license link + goes to one of the standard licenses at creativecommons.org, it will populate the permissions + based on it's know set (See License.Behaviour).

+ +

The module has 2 fields on it. One is "allLicenses". This is simply an array of all licenses + in a feed. The second one "licenses" contains licenses that apply to a specific element (feed or + entry). Licenses then contain "permits" and "requires" behaviours. If a license is used that + the system can't determine anything about, these will be null. Zero-lenght means "known and + empty."

+ +

At this time, because of a ROME limitation, writing RSS1 feeds is not possible. However, + if you read an RSS1 feed, you can convert it to an RSS2 feed properly.

+ +

Sample Usage: + 

+        
+        CreativeCommons commons = new CreativeCommonsImpl();
+        commons.setLicense( new License[]{ License.NONCOMMERCIAL } );
+        // Note, you do not have to setAllLicenses right now. When the RSS1 functionality is
+        // added, this will be required at the Feed level only.
+        ArrayList modules = new ArrayList()
+        modules.add( commons );
+        syndEntry.setModules( commons );
+        
+        //Alternately, to get the module:
+        CreativeCommons commons = (CreativeCommons) syndFeed.getModule( CreativeCommons.URI );
+        
+
+

+ 
+ * This library is provided under dual licenses. 
+ * You may choose the terms of the Lesser General Public License or the Apache
+ * License at your discretion.
+ *
+ *  Copyright (C) 2005  Robert Cooper, Temple of the Screaming Penguin
+ *
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.   
+
+ + diff --git a/src/main/java/com/sun/syndication/feed/module/cc/types/License.java b/src/main/java/com/sun/syndication/feed/module/cc/types/License.java new file mode 100644 index 0000000..225c360 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/cc/types/License.java @@ -0,0 +1,202 @@ +/* + * LicenseEnumeration.java + * + * Created on November 20, 2005, 3:20 PM + * +* This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.cc.types; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; +import java.util.HashMap; +import java.util.Iterator; +import java.util.StringTokenizer; + +/** + * @version $Revision: 1.1 $ + * @author Robert "kebernet" Cooper + */ +public class License { + private static final String CC_START = "http://creativecommons.org/licenses/"; + private static final HashMap lookupLicense = new HashMap(); + public static final License NO_DERIVS = new License("http://creativecommons.org/licenses/nd/1.0/",new Behaviour[0],new Behaviour[] { + Behaviour.DISTRIBUTION,Behaviour.REPRODUCTION + }); + public static final License NO_DERIVS_NONCOMMERCIAL = new License("http://creativecommons.org/licenses/nd-nc/1.0/",new Behaviour[] { + Behaviour.NONCOMMERCIAL + },new Behaviour[] {Behaviour.DISTRIBUTION,Behaviour.REPRODUCTION}); + public static final License NONCOMMERCIAL = new License("http://creativecommons.org/licenses/nc/1.0/",new Behaviour[] { + Behaviour.NONCOMMERCIAL + },new Behaviour[] { + Behaviour.DERIVATIVE,Behaviour.DISTRIBUTION,Behaviour.REPRODUCTION + }); + public static final License SHARE_ALIKE = new License("http://creativecommons.org/licenses/sa/1.0/",new Behaviour[] { + Behaviour.COPYLEFT + },new Behaviour[] { + Behaviour.DERIVATIVE,Behaviour.DISTRIBUTION,Behaviour.REPRODUCTION + }); + public static final License SHARE_ALIKE_NONCOMMERCIAL = new License("http://creativecommons.org/licenses/nc-sa/1.0/",new Behaviour[] { + Behaviour.COPYLEFT,Behaviour.NONCOMMERCIAL + },new Behaviour[] { + Behaviour.DERIVATIVE,Behaviour.DISTRIBUTION,Behaviour.REPRODUCTION + }); + public static final License SHARE_ALIKE_ATTRIBUTION = new License("http://creativecommons.org/licenses/by-sa/2.5/",new Behaviour[] { + Behaviour.COPYLEFT,Behaviour.ATTRIBUTION + },new Behaviour[] { + Behaviour.DERIVATIVE,Behaviour.DISTRIBUTION,Behaviour.REPRODUCTION + }); + public static final License SHARE_ALIKE_NONCOMMERCIAL_ATTRIBUTION = new License("http://creativecommons.org/licenses/by-nc-sa/2.5/",new Behaviour[] { + Behaviour.COPYLEFT,Behaviour.ATTRIBUTION,Behaviour.NONCOMMERCIAL + },new Behaviour[] { + Behaviour.DERIVATIVE,Behaviour.DISTRIBUTION,Behaviour.REPRODUCTION + }); + public static final License NONCOMMERCIAL_ATTRIBUTION = new License("http://creativecommons.org/licenses/by-nc/2.5/",new Behaviour[] { + Behaviour.ATTRIBUTION,Behaviour.NONCOMMERCIAL + },new Behaviour[] { + Behaviour.DERIVATIVE,Behaviour.DISTRIBUTION,Behaviour.REPRODUCTION + }); + public static final License NONCOMMERCIAL_ATTRIBUTION_NO_DERIVS = new License("http://creativecommons.org/licenses/by-nc-nd/2.5/",new Behaviour[] { + Behaviour.ATTRIBUTION,Behaviour.NONCOMMERCIAL + },new Behaviour[] {Behaviour.DISTRIBUTION,Behaviour.REPRODUCTION}); + public static final License ATTRIBUTION_NO_DERIVS = new License("http://creativecommons.org/licenses/by-nd/2.5/",new Behaviour[] { + Behaviour.ATTRIBUTION + },new Behaviour[] {Behaviour.DISTRIBUTION,Behaviour.REPRODUCTION}); + public static final License ATTRIBUTION = new License("http://creativecommons.org/licenses/by/2.5/",new Behaviour[] { + Behaviour.ATTRIBUTION + },new Behaviour[] { + Behaviour.DERIVATIVE,Behaviour.DISTRIBUTION,Behaviour.REPRODUCTION + }); + private String uri; + private Behaviour[] permits; + private Behaviour[] requires; + + /** + * Creates a new instance of License + */ + public License(String uri,Behaviour[] requires,Behaviour[] permits) { + this.requires = requires; + this.permits = permits; + this.uri = uri; + License.lookupLicense.put(uri,this); + + if(this.uri.endsWith("/")) { + //System.out.println(uri.substring(0,this.uri.lastIndexOf("/"))); + License.lookupLicense.put(uri.substring(0,this.uri.lastIndexOf("/")),this); + } + } + + public static License findByValue(String uri) { + License found = (License)License.lookupLicense.get(uri); + + //No I am going to try an guess about unknown licenses + // This is try and match known CC licenses of other versions or various URLs to + // current licenses, then make a new one with the same permissions. + if(found == null && uri.startsWith("http://") && uri.toLowerCase().indexOf("creativecommons.org") != -1) { + Iterator it = License.lookupLicense.keySet().iterator(); + while(it.hasNext()&&(found == null)) { + try{ + String key = (String)it.next(); + if(key.startsWith( CC_START ) ){ + String licensePath = key.substring( CC_START.length(), key.length() ); + StringTokenizer tok = new StringTokenizer( licensePath, "/"); + String license = tok.nextToken(); + String version = tok.nextToken(); + if( uri.toLowerCase().indexOf("creativecommons.org/licenses/"+license) != -1){ + License current = (License) lookupLicense.get( key ); + found = new License( uri, current.getRequires(), current.getPermits() ); + } + } + } catch(Exception e){ + e.printStackTrace(); + } + } + } + //OK, we got here. If we haven't found a match, return a new License with unknown permissions. + if( found == null ){ + found = new License( uri, null, null ); + } + return found; + } + + public Behaviour[] getPermits() { + return this.permits; + } + + public Behaviour[] getRequires() { + return this.requires; + } + public String toString() { + + ToStringBean tsb = new ToStringBean( License.class, this ); + return tsb.toString(); + } + public String getValue() { + return this.uri; + } + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(License.class,this); + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(License.class,this); + return equals.beanHashCode(); + } + public static class Behaviour { + private static final HashMap lookup = new HashMap(); + public static final Behaviour REPRODUCTION = new Behaviour("http://web.resource.org/cc/Reproduction"); + public static final Behaviour DISTRIBUTION = new Behaviour("http://web.resource.org/cc/Distribution"); + public static final Behaviour DERIVATIVE = new Behaviour("http://web.resource.org/cc/DerivativeWorks"); + public static final Behaviour NOTICE = new Behaviour("http://web.resource.org/cc/Notice"); + public static final Behaviour ATTRIBUTION = new Behaviour("http://web.resource.org/cc/Attribution"); + public static final Behaviour COPYLEFT = new Behaviour("http://web.resource.org/cc/Copyleft"); + public static final Behaviour NONCOMMERCIAL = new Behaviour("http://web.resource.org/cc/Noncommercial"); + private String uri; + + private Behaviour(String uri) { + this.uri = uri; + Behaviour.lookup.put(uri,this); + } + + public static Behaviour findByValue(String uri) { + return (Behaviour)Behaviour.lookup.get(uri); + } + + public String toString() { + return this.uri; + } + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/cc/types/package.html b/src/main/java/com/sun/syndication/feed/module/cc/types/package.html new file mode 100644 index 0000000..d1ef41e --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/cc/types/package.html @@ -0,0 +1,45 @@ + + + + + + + +This package contains datatypes for use with the plug in. + 
+ * This library is provided under dual licenses. 
+ * You may choose the terms of the Lesser General Public License or the Apache
+ * License at your discretion.
+ *
+ *  Copyright (C) 2005  Robert Cooper, Temple of the Screaming Penguin
+ *
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.   
+
+ + diff --git a/src/main/java/com/sun/syndication/feed/module/content/ContentItem.java b/src/main/java/com/sun/syndication/feed/module/content/ContentItem.java new file mode 100644 index 0000000..e7ea67a --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/content/ContentItem.java @@ -0,0 +1,203 @@ +/* + * ContentItem.java + * + * Created on January 12, 2005, 8:52 AM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * + */ +package com.sun.syndication.feed.module.content; + +import java.util.List; + + +/** This class represents a content item per the "Original Syntax". + * http://purl.org/rss/1.0/modules/content/ + * @version $Revision: 1.1 $ + * @author Robert "kebernet" Cooper + */ +public class ContentItem implements Cloneable { + private String contentFormat; + private String contentEncoding; + private String contentValue; + private List contentValueDOM; + private String contentAbout; + private String contentValueParseType; + private List contentValueNamespace; + private String contentResource; + + /** Creates a new instance of ContentItem */ + public ContentItem() { + } + + public String getContentFormat() { + return this.contentFormat; + } + + public void setContentFormat(String contentFormat) { + this.contentFormat = contentFormat; + } + + public String getContentEncoding() { + return this.contentEncoding; + } + + public void setContentEncoding(String contentEncoding) { + this.contentEncoding = contentEncoding; + } + + public String getContentValue() { + return this.contentValue; + } + + public void setContentValue(String contentValue) { + this.contentValue = contentValue; + } + + public List getContentValueDOM() { + return this.contentValueDOM; + } + + public void setContentValueDOM(List contentValueDOM) { + this.contentValueDOM = contentValueDOM; + } + + public String getContentAbout() { + return this.contentAbout; + } + + public void setContentAbout(String contentAbout) { + this.contentAbout = contentAbout; + } + + public String getContentValueParseType() { + return this.contentValueParseType; + } + + public void setContentValueParseType(String contentValueParseType) { + this.contentValueParseType = contentValueParseType; + } + + public List getContentValueNamespaces() { + return this.contentValueNamespace; + } + + public void setContentValueNamespaces(List contentValueNamespace) { + this.contentValueNamespace = contentValueNamespace; + } + + public String getContentResource() { + return this.contentResource; + } + + public void setContentResource(String contentResource) { + this.contentResource = contentResource; + } + + public boolean equals(Object obj) { + if (obj == null) { + return false; + } + if (getClass() != obj.getClass()) { + return false; + } + final ContentItem other = (ContentItem) obj; + if ((this.contentFormat == null) ? (other.contentFormat != null) : !this.contentFormat.equals(other.contentFormat)) { + //System.out.println("format"); + return false; + } + if ((this.contentEncoding == null) ? (other.contentEncoding != null) : !this.contentEncoding.equals(other.contentEncoding)) { + //System.out.println("enc"); + return false; + } + String thisCV = this.contentValue.replaceAll(" xmlns=\"http://www.w3.org/1999/xhtml\"", "").trim();; + String thatCV = other.contentValue.replaceAll(" xmlns=\"http://www.w3.org/1999/xhtml\"", "").trim(); + if ((this.contentValue == null) ? (other.contentValue != null) : !thisCV.equals(thatCV)) { + + return false; + } + if (this.contentValueDOM != other.contentValueDOM && (this.contentValueDOM == null || !this.contentValueDOM.equals(other.contentValueDOM))) { + //System.out.println("vd"); + return false; + } + if ((this.contentAbout == null) ? (other.contentAbout != null) : !this.contentAbout.equals(other.contentAbout)) { + //System.out.println("abt"); + return false; + } + if ((this.contentValueParseType == null) ? (other.contentValueParseType != null) : !this.contentValueParseType.equals(other.contentValueParseType)) { + //System.out.println("pt"); + return false; + } + if (this.contentValueNamespace != other.contentValueNamespace && (this.contentValueNamespace == null || !this.contentValueNamespace.equals(other.contentValueNamespace))) { + //System.out.println("ns"); + return false; + } + if ((this.contentResource == null) ? (other.contentResource != null) : !this.contentResource.equals(other.contentResource)) { + //System.out.println("res"); + return false; + } + return true; + } + + + public int hashCode() { + int hash = 7; + hash = 97 * hash + (this.contentFormat != null ? this.contentFormat.hashCode() : 0); + hash = 97 * hash + (this.contentEncoding != null ? this.contentEncoding.hashCode() : 0); + hash = 97 * hash + (this.contentValue != null ? this.contentValue.hashCode() : 0); + hash = 97 * hash + (this.contentValueDOM != null ? this.contentValueDOM.hashCode() : 0); + hash = 97 * hash + (this.contentAbout != null ? this.contentAbout.hashCode() : 0); + hash = 97 * hash + (this.contentValueParseType != null ? this.contentValueParseType.hashCode() : 0); + hash = 97 * hash + (this.contentValueNamespace != null ? this.contentValueNamespace.hashCode() : 0); + hash = 97 * hash + (this.contentResource != null ? this.contentResource.hashCode() : 0); + return hash; + } + + + public Object clone() { + ContentItem o = new ContentItem(); + o.contentAbout = this.contentAbout; + o.contentEncoding = this.contentEncoding; + o.contentFormat = this.contentFormat; + o.contentResource = this.contentResource; + o.contentValue = this.contentValue; + o.contentValueDOM = this.contentValueDOM; + o.contentValueNamespace = this.contentValueNamespace; + o.contentValueParseType = this.contentValueParseType; + + return o; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/content/ContentModule.java b/src/main/java/com/sun/syndication/feed/module/content/ContentModule.java new file mode 100644 index 0000000..d6a1776 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/content/ContentModule.java @@ -0,0 +1,97 @@ +/* + * ContentModule.java + * + * Created on January 11, 2005, 1:02 PM + * + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.content; + +import java.util.List; + + +/** + * @version $Revision: 1.1 $ + * @author Robert "kebernet" Cooper + */ +public interface ContentModule extends com.sun.syndication.feed.module.Module { + public static final String URI = "http://purl.org/rss/1.0/modules/content/"; + public static final String RDF_URI = "http://www.w3.org/1999/02/22-rdf-syntax-ns#"; + + /** Returns a List of Strings containing the New Syntax Encoded values + * are in the element. + * @return List of content Strings + */ + public List getEncodeds(); + + /** Sets a List of Strings containing the New Syntax Encoded values + * are in the element. + * @return List of content Strings + */ + public void setEncodeds(List encodeds); + + public void copyFrom(Object obj); + + public Class getInterface(); + + public String getUri(); + + public String toString(String str); + + /** Contains a list of ContentItems that represent the "Original Syntax" set. + * @see com.totsp.xml.syndication.content.ContentItem + * @return List of ContentItems. + */ + public List getContentItems(); + + /** Contains a list of ContentItems that represent the "Original Syntax" set. + * @see com.totsp.xml.syndication.content.ContentItem + * @param List of ContentItems. + */ + public void setContentItems(List list); + + /** Returns a List of Strings containing whatever new or original syntax items + * are in the element. + * @return List of content Strings + */ + public List getContents(); + + /** Sets a List of Strings containing whatever new or original syntax items + * are in the element. + * @return List of content Strings + */ + public void setContents(List contents); +} diff --git a/src/main/java/com/sun/syndication/feed/module/content/ContentModuleImpl.java b/src/main/java/com/sun/syndication/feed/module/content/ContentModuleImpl.java new file mode 100644 index 0000000..6b4561d --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/content/ContentModuleImpl.java @@ -0,0 +1,108 @@ +/* + * ContentModuleImpl.java + * + * Created on January 11, 2005, 1:07 PM + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * + */ +package com.sun.syndication.feed.module.content; + +import java.util.ArrayList; +import java.util.List; + + +/** + * @version $Revision: 1.4 $ + * @author Robert "kebernet" Cooper + */ +public class ContentModuleImpl extends com.sun.syndication.feed.module.ModuleImpl implements ContentModule { + private List encodeds; + private List contents; + private List contentItems; + + public ContentModuleImpl() { + super(ContentModuleImpl.class, URI); + } + + protected ContentModuleImpl(java.lang.Class beanClass, java.lang.String uri) { + super(beanClass, uri); + } + + public List getEncodeds() { + this.encodeds = this.encodeds == null ? new ArrayList() : this.encodeds; + return this.encodeds; + } + + public void setEncodeds(List encodeds) { + this.encodeds = encodeds; + } + + public void copyFrom(Object obj) { + ContentModule cm = (ContentModule) obj; + this.setEncodeds(cm.getEncodeds()); + this.setContentItems(cm.getContentItems()); + this.setContents(cm.getContents()); + } + + public Class getInterface() { + return ContentModule.class; + } + + public List getContentItems() { + this.contentItems = this.contentItems == null ? new ArrayList() : this.contentItems; + return this.contentItems; + } + + public void setContentItems(List list) { + this.contentItems = list; + } + + public List getContents() { + this.contents = this.contents == null ? new ArrayList() : this.contents; + return this.contents; + } + + public void setContents(List contents) { + this.contents = contents; + } + + public String toString(String str) { + return contentItems.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/content/io/ContentModuleGenerator.java b/src/main/java/com/sun/syndication/feed/module/content/io/ContentModuleGenerator.java new file mode 100644 index 0000000..5766582 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/content/io/ContentModuleGenerator.java @@ -0,0 +1,194 @@ +/* + * ContentModuleGenerator.java + * + * Created on January 11, 2005, 1:41 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * + */ +package com.sun.syndication.feed.module.content.io; + +import com.sun.syndication.feed.module.content.ContentItem; +import com.sun.syndication.feed.module.content.ContentModule; +import org.jdom.Attribute; +import org.jdom.CDATA; +import org.jdom.Content; +import org.jdom.Element; +import org.jdom.Namespace; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Set; + +/** + * @version $Revision: 1.2 $ + * @author Robert "kebernet" Cooper + */ +public class ContentModuleGenerator implements com.sun.syndication.io.ModuleGenerator { + private static final Namespace CONTENT_NS = Namespace.getNamespace("content", ContentModule.URI); + private static final Namespace RDF_NS = Namespace.getNamespace("rdf", ContentModule.RDF_URI); + private static final Set NAMESPACES; + + static { + Set nss = new HashSet(); + nss.add(CONTENT_NS); + NAMESPACES = Collections.unmodifiableSet(nss); + } + + /** Creates a new instance of ContentModuleGenerator */ + public ContentModuleGenerator() { + } + + public void generate(com.sun.syndication.feed.module.Module module, org.jdom.Element element) { + // this is not necessary, it is done to avoid the namespace definition in every item. + Element root = element; + + while ((root.getParent() != null) && root.getParent() instanceof Element) { + root = (Element) root.getParent(); + } + + root.addNamespaceDeclaration(CONTENT_NS); + + if (!(module instanceof ContentModule)) { + return; + } + + ContentModule cm = (ContentModule) module; + + List encodeds = cm.getEncodeds(); + + // + if (encodeds != null) { + System.out.println(cm.getEncodeds().size()); + for (int i = 0; i < encodeds.size(); i++) { + element.addContent(generateCDATAElement("encoded", encodeds.get(i).toString())); + } + } + + List contentItems = cm.getContentItems(); + + if ((contentItems != null) && (contentItems.size() > 0)) { + Element items = new Element("items", CONTENT_NS); + Element bag = new Element("Bag", RDF_NS); + items.addContent(bag); + + for (int i = 0; i < contentItems.size(); i++) { + ContentItem contentItem = (ContentItem) contentItems.get(i); + Element li = new Element("li", RDF_NS); + Element item = new Element("item", CONTENT_NS); + + if (contentItem.getContentAbout() != null) { + Attribute about = new Attribute("about", contentItem.getContentAbout(), RDF_NS); + item.setAttribute(about); + } + + if (contentItem.getContentFormat() != null) { + //System.out.println( "Format"); + Element format = new Element("format", CONTENT_NS); + Attribute formatResource = new Attribute("resource", contentItem.getContentFormat(), RDF_NS); + format.setAttribute(formatResource); + + item.addContent(format); + } + + if (contentItem.getContentEncoding() != null) { + //System.out.println( "Encoding"); + Element encoding = new Element("encoding", CONTENT_NS); + Attribute encodingResource = new Attribute("resource", contentItem.getContentEncoding(), RDF_NS); + encoding.setAttribute(encodingResource); + item.addContent(encoding); + } + + if (contentItem.getContentValue() != null) { + Element value = new Element("value", RDF_NS); + + if (contentItem.getContentValueParseType() != null) { + Attribute parseType = new Attribute("parseType", contentItem.getContentValueParseType(), RDF_NS); + value.setAttribute(parseType); + } + + if (contentItem.getContentValueNamespaces() != null) { + List namespaces = contentItem.getContentValueNamespaces(); + + for (int ni = 0; ni < namespaces.size(); ni++) { + value.addNamespaceDeclaration((Namespace) namespaces.get(ni)); + } + } + + List detached = new ArrayList(); + + for (int c = 0; + c < contentItem.getContentValueDOM().size(); c++) { + detached.add(((Content) ((Content) contentItem.getContentValueDOM().get(c)).clone()).detach()); + } + + value.setContent(detached); + item.addContent(value); + } // end value + + li.addContent(item); + bag.addContent(li); + } //end contentItems loop + + element.addContent(items); + } + } + + protected Element generateSimpleElement(String name, String value) { + Element element = new Element(name, CONTENT_NS); + element.addContent(value); + + return element; + } + + protected Element generateCDATAElement(String name, String value) { + Element element = new Element(name, CONTENT_NS); + CDATA cdata = new CDATA(value); + element.addContent(cdata); + + return element; + } + + public String getNamespaceUri() { + return ContentModule.URI; + } + + public java.util.Set getNamespaces() { + return NAMESPACES; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/content/io/ContentModuleParser.java b/src/main/java/com/sun/syndication/feed/module/content/io/ContentModuleParser.java new file mode 100644 index 0000000..c984ea6 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/content/io/ContentModuleParser.java @@ -0,0 +1,158 @@ +/* + * ContentModuleParser.java + * + * Created on January 11, 2005, 1:23 PM + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * + */ +package com.sun.syndication.feed.module.content.io; + +import com.sun.syndication.feed.module.content.ContentItem; +import com.sun.syndication.feed.module.content.ContentModule; +import com.sun.syndication.feed.module.content.ContentModuleImpl; +import org.jdom.Attribute; +import org.jdom.Element; +import org.jdom.Namespace; + +import org.jdom.output.XMLOutputter; + +import java.util.ArrayList; +import java.util.List; +/** + * @version $Revision: 1.3 $ + * @author Robert "kebernet" Cooper + */ +public class ContentModuleParser implements com.sun.syndication.io.ModuleParser { + private static final Namespace CONTENT_NS = Namespace.getNamespace("content", ContentModule.URI); + private static final Namespace RDF_NS = Namespace.getNamespace("rdf", ContentModule.RDF_URI); + + /** Creates a new instance of ContentModuleParser */ + public ContentModuleParser() { + } + + public String getNamespaceUri() { + return ContentModule.URI; + } + + public com.sun.syndication.feed.module.Module parse(org.jdom.Element element) { + boolean foundSomething = false; + ContentModule cm = new ContentModuleImpl(); + List encodeds = element.getChildren("encoded", CONTENT_NS); + ArrayList contentStrings = new ArrayList(); + ArrayList encodedStrings = new ArrayList(); + + if (encodeds.size() > 0) { + foundSomething = true; + + for (int i = 0; i < encodeds.size(); i++) { + Element encodedElement = (Element) encodeds.get(i); + encodedStrings.add(encodedElement.getText()); + contentStrings.add(encodedElement.getText()); + } + } + + ArrayList contentItems = new ArrayList(); + List items = element.getChildren("items", CONTENT_NS); + + for (int i = 0; i < items.size(); i++) { + foundSomething = true; + + List lis = ((Element) items.get(i)).getChild("Bag", RDF_NS).getChildren("li", RDF_NS); + + for (int j = 0; j < lis.size(); j++) { + ContentItem ci = new ContentItem(); + Element li = (Element) lis.get(j); + Element item = li.getChild("item", CONTENT_NS); + Element format = item.getChild("format", CONTENT_NS); + Element encoding = item.getChild("encoding", CONTENT_NS); + Element value = item.getChild("value", RDF_NS); + + if (value != null) { + if (value.getAttributeValue("parseType", RDF_NS) != null) { + ci.setContentValueParseType(value.getAttributeValue("parseType", RDF_NS)); + } + + if ((ci.getContentValueParseType() != null) && ci.getContentValueParseType().equals("Literal")) { + ci.setContentValue(getXmlInnerText(value)); + contentStrings.add(getXmlInnerText(value)); + ci.setContentValueNamespaces(value.getAdditionalNamespaces()); + } else { + ci.setContentValue(value.getText()); + contentStrings.add(value.getText()); + } + + ci.setContentValueDOM(((Element) value.clone()).getContent()); + } + + if (format != null) { + ci.setContentFormat(format.getAttribute("resource", RDF_NS).getValue()); + } + + if (encoding != null) { + ci.setContentEncoding(encoding.getAttribute("resource", RDF_NS).getValue()); + } + + if (item != null) { + Attribute about = item.getAttribute("about", RDF_NS); + + if (about != null) { + ci.setContentAbout(about.getValue()); + } + } + + contentItems.add(ci); + } + } + + cm.setEncodeds(encodedStrings); + cm.setContentItems(contentItems); + cm.setContents(contentStrings); + + return (foundSomething) ? cm : null; + } + + protected String getXmlInnerText(Element e) { + StringBuffer sb = new StringBuffer(); + XMLOutputter xo = new XMLOutputter(); + List children = e.getContent(); + sb.append(xo.outputString(children)); + + return sb.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/content/package.html b/src/main/java/com/sun/syndication/feed/module/content/package.html new file mode 100644 index 0000000..3d84caf --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/content/package.html @@ -0,0 +1,66 @@ + + + + + + + + + This is a ROME plug in that implements the Content RSS extension. + http://purl.org/rss/1.0/modules/content/ + + Note, this supports both the "Original" syntax via the ContentItem object + and the "New" Syntax via the ".getEncodeds()" method on the ContentModule. + +

Sample Usage:

+ 
+        SyndFeedInput input = new SyndFeedInput();
+        SyndFeed syndfeed = input.build(new XmlReader(feed.toURL()));
+
+        Module module = syndfeed.getModule("http://purl.org/rss/1.0/modules/content/");
+        ContentModule content = (ContentModule) module;
+        
+        Iterator it = content.getEncodeds().iterator();
+        System.out.println( it.next() );
+
+ + + + + 
+ * This library is provided under dual licenses.
+ * You may choose the terms of the Lesser General Public License or the Apache
+ * License at your discretion.
+ *
+ *  Copyright (C) 2005  Robert Cooper, Temple of the Screaming Penguin
+ *
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+
+ + diff --git a/src/main/java/com/sun/syndication/feed/module/georss/GMLGenerator.java b/src/main/java/com/sun/syndication/feed/module/georss/GMLGenerator.java new file mode 100644 index 0000000..7b0fc16 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/georss/GMLGenerator.java @@ -0,0 +1,163 @@ +/* + * Copyright 2006 Marc Wick, geonames.org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.georss; + +import java.util.*; + +import org.jdom.Element; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.io.ModuleGenerator; + +import com.sun.syndication.feed.module.georss.geometries.*; + +/** + * GMLGenerator produces georss elements in georss GML format. + * + * @author Marc Wick + * @version $Id: GMLGenerator.java,v 1.1 2007/04/18 09:59:29 marcwick Exp $ + * + */ +public class GMLGenerator implements ModuleGenerator { + + private static final Set NAMESPACES; + + static { + Set nss = new HashSet(); + nss.add(GeoRSSModule.GML_NS); + NAMESPACES = Collections.unmodifiableSet(nss); + } + + private Element createPosListElement(PositionList posList) { + Element posElement = new Element("posList", GeoRSSModule.GML_NS); + StringBuffer sb = new StringBuffer(); + for (int i=0; i"http://www.georss.org/georss" + */ + public static final String GEORSS_GEORSS_URI = "http://www.georss.org/georss"; + + /** + * namespace URI for w3c georss : + * "http://www.w3.org/2003/01/geo/wgs84_pos#" + */ + public static final String GEORSS_W3CGEO_URI = "http://www.w3.org/2003/01/geo/wgs84_pos#"; + + /** + * namespace URI for GML georss : "http://www.opengis.net/gml" + */ + public static final String GEORSS_GML_URI = "http://www.opengis.net/gml"; + + /** + * Namespace for georss simple : + * xmlns:georss="http://www.georss.org/georss" + */ + public static final Namespace SIMPLE_NS = Namespace.getNamespace("georss", + GeoRSSModule.GEORSS_GEORSS_URI); + + /** + * + * Namespace for w3c georss : + * xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#" + */ + public static final Namespace W3CGEO_NS = Namespace.getNamespace("geo", + GeoRSSModule.GEORSS_W3CGEO_URI); + + /** + * + * Namespace for gml georss : xmlns:gml="http://www.opengis.net/gml" + */ + public static final Namespace GML_NS = Namespace.getNamespace("gml", + GeoRSSModule.GEORSS_GML_URI); + + protected GeoRSSModule(java.lang.Class beanClass, java.lang.String uri) { + super(beanClass, uri); + } + + /** + * Set geometry of georss element + * + * @param geometry + * geometry + */ + public void setGeometry(AbstractGeometry geometry) { + this.geometry = geometry; + } + + + /** + * returns the geometry + * + * @return geometry + */ + public AbstractGeometry getGeometry() { + return geometry; + } + + /** + * Convenience method to return point geometry. + * Returns null if the geometry is non-point. + * + * @return geometry + */ + public Position getPosition() { + if (geometry instanceof Point) + return ((Point)geometry).getPosition(); + return null; + } + + /** + * Convenience method to set point geometry. + * + * @return geometry + */ + public void setPosition(Position pos) { + if (pos != null) + geometry = new Point(pos); + } + + /* + * (non-Javadoc) + * + * @see com.sun.syndication.feed.CopyFrom#copyFrom(java.lang.Object) + */ + public void copyFrom(Object obj) { + GeoRSSModule geoRSSModule = (GeoRSSModule) obj; + geometry = geoRSSModule.getGeometry(); + try { + geometry = (AbstractGeometry)geometry.clone(); + } catch (CloneNotSupportedException ex) { + ex.printStackTrace(); + } + } + + public Object clone() throws CloneNotSupportedException { + try { + GeoRSSModule retval = (GeoRSSModule)super.clone(); + if (geometry != null) + retval.geometry = (AbstractGeometry)geometry.clone(); + return retval; + } catch(Exception ex) {ex.printStackTrace();} + throw new CloneNotSupportedException(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/georss/GeoRSSPoint.java b/src/main/java/com/sun/syndication/feed/module/georss/GeoRSSPoint.java new file mode 100644 index 0000000..780bce8 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/georss/GeoRSSPoint.java @@ -0,0 +1,62 @@ +/* + * Copyright 2007 Marc Wick, geonames.org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.georss; + +/** + * @author marc + * + */ +public class GeoRSSPoint implements Cloneable { + private double latitude; + + private double longitude; + + /** + * @return the latitude + */ + public double getLatitude() { + return latitude; + } + + /** + * @param latitude + * the latitude to set + */ + public void setLatitude(double latitude) { + this.latitude = latitude; + } + + /** + * @return the longitude + */ + public double getLongitude() { + return longitude; + } + + /** + * @param longitude + * the longitude to set + */ + public void setLongitude(double longitude) { + this.longitude = longitude; + } + + public Object clone() throws CloneNotSupportedException { + return super.clone(); + } + +} diff --git a/src/main/java/com/sun/syndication/feed/module/georss/GeoRSSUtils.java b/src/main/java/com/sun/syndication/feed/module/georss/GeoRSSUtils.java new file mode 100644 index 0000000..9002e6c --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/georss/GeoRSSUtils.java @@ -0,0 +1,130 @@ +/* + * Copyright 2006 Marc Wick, geonames.org + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.georss; + +import com.sun.syndication.feed.synd.SyndEntry; +import com.sun.syndication.feed.synd.SyndFeed; + +/** + * static utility methods for georss. + * + * @author Marc Wick + * @version $Id: GeoRSSUtils.java,v 1.4 2007/04/18 09:59:29 marcwick Exp $ + * + */ +public class GeoRSSUtils { + + + static String trimWhitespace(String in) { + StringBuffer strbuf = new StringBuffer(); + int i = 0; + for (; i= new_size) + return; + if (new_size < 4) + new_size = 4; + else + new_size = (int)Math.ceil(Math.pow(2, Math.ceil(Math.log(new_size)/Math.log(2)))); + double [] tmp = new double[new_size]; + if (longitude != null) + System.arraycopy(longitude, 0, tmp, 0, size); + longitude = tmp; + tmp = new double[new_size]; + if (latitude != null) + System.arraycopy(latitude, 0, tmp, 0, size); + latitude = tmp; + } + + /** + * @return the number of positions in the list + */ + public int size() { + return size; + } + + /** + * @param pos position index + * @return longitude for position + */ + public double getLongitude(int pos) { + return longitude[pos]; + } + + /** + * @param pos position index + * @return latitude for position + */ + public double getLatitude(int pos) { + return latitude[pos]; + } + + /** + * Add a position at the end of the list + * @param latitude + * @param longitude + */ + public void add(double latitude, double longitude) { + ensureCapacity(size+1); + this.longitude[size] = longitude; + this.latitude[size] = latitude; + ++size; + } + + /** + * 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 + * @param longitude + */ + public void insert(int pos, double latitude, double longitude) { + ensureCapacity(size+1); + System.arraycopy(this.longitude, pos, this.longitude, pos+1, size-pos); + System.arraycopy(this.latitude, pos, this.latitude, pos+1, size-pos); + this.longitude[pos] = longitude; + this.latitude[pos] = latitude; + ++size; + } + + /** + * Replace the position at the index with new values + * + * @param pos position index + * @param latitude + * @param longitude + */ + public void replace(int pos, double latitude, double longitude) { + this.longitude[pos] = longitude; + this.latitude[pos] = latitude; + } + + /** + * Remove the position at the index, the rest of the list is shifted one place to the "left" + * + * @param pos position index + */ + public void remove(int pos) { + System.arraycopy(longitude, pos+1, longitude, pos, size-pos-1); + System.arraycopy(latitude, pos+1, latitude, pos, size-pos-1); + --size; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/georss/geometries/package.html b/src/main/java/com/sun/syndication/feed/module/georss/geometries/package.html new file mode 100644 index 0000000..2d7654a --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/georss/geometries/package.html @@ -0,0 +1,14 @@ + + + + + Geometry package documetation + + + This package contains classes for handling of geometric objects in a + geographical context, mainly for + use with the GeoRSS library. The geometry objects closely mimics the model + used for the geometry part of GML + 3.1.1 "simple features", and supports the whole GeoRSS GML profile. + + diff --git a/src/main/java/com/sun/syndication/feed/module/georss/package.html b/src/main/java/com/sun/syndication/feed/module/georss/package.html new file mode 100644 index 0000000..bf84f47 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/georss/package.html @@ -0,0 +1,46 @@ + + + + + GeoRSS package documentation + + + + + +This package contains classes to enable the rome rss library with georss support. +GeoRSS describes a number of ways to encoding location in RSS feeds + + +

Code Examples

+ +

GeoRSS Consumer

+ + 
   SyndFeedInput input = new SyndFeedInput();
+       SyndFeed feed = input.build(new XmlReader(new URL(
+             "http://www.geonames.org/recent-changes.xml")));
+
+       List<syndentry> entries = feed.getEntries();
+       for (SyndEntry entry : entries) {
+            GeoRSSModule geoRSSModule = GeoRSSUtils.getGeoRSS(entry);
+            System.out.println(entry.getTitle() + " : lat="
+                  + geoRSSModule.getPosition().getLatitude() + ",lng="
+                  + geoRSSModule.getPosition().getLongitude() + ", desc="
+                  + entry.getDescription().getValue() + "; time="
+                  + entry.getPublishedDate());
+       }
+
+ + + + +

GeoRSS Producer

+ + 
    GeoRSSModule geoRSSModule = new W3CGeoModuleImpl();
+        //GeoRSSModule geoRSSModule = new SimpleModuleImpl();
+        geoRSSModule.setPosition(new Position(47.0, 9.0));
+        entry.getModules().add(geoRSSModule);
+
+ + + diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/AbstractITunesObject.java b/src/main/java/com/sun/syndication/feed/module/itunes/AbstractITunesObject.java new file mode 100644 index 0000000..bb0778c --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/AbstractITunesObject.java @@ -0,0 +1,226 @@ +/* + * AbstractITunesObject.java + * + * Created on August 1, 2005, 7:37 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.itunes; + + + +/** + * This is an abstract object that implements the attributes common across Feeds + * or Items in an iTunes compatible RSS feed. + * @version $Revision: 1.4 $ + * @author Robert "kebernet" Cooper + */ +public abstract class AbstractITunesObject implements ITunes, java.lang.Cloneable { + /** + * The URI that iTunes used for its custom tags. + *

What is up with using a versioned DTD anyway?

\ + */ + public static final String URI = "http://www.itunes.com/dtds/podcast-1.0.dtd"; + + /** + * The RDF namespace URI. + */ + public static final String RDF_URI = "http://www.w3.org/1999/02/22-rdf-syntax-ns#"; + + /** + * A default prefix to use for itunes tags. + */ + public static final String PREFIX = "itunes"; + private String author; + private boolean block; + private boolean explicit; + private String[] keywords; + private String subtitle; + private String summary; + + /** + * Defined by the ROME module API + * @param obj Object to copy from + */ + public abstract void copyFrom(Object obj); + + /** + * Defined by the ROME API + * @return Class of the Interface for this module. + */ + public Class getInterface() { + return getClass(); + } + + /** + * The URI this module implements + * @return "http://www.itunes.com/dtds/podcast-1.0.dtd" + */ + public String getUri() { + return AbstractITunesObject.URI; + } + + /** + * Required by the ROME API + * @return A clone of this module object + */ + public abstract Object clone(); + + /** + * Returns the author string for this feed or entry + * @return Returns the author string for this feed or entry + */ + public String getAuthor() { + return author; + } + + /** + * Sets the author string for this feed or entry + * @param author Sets the author string for this feed or entry + */ + public void setAuthor(String author) { + this.author = author; + } + + /** + * Boolean as to whether to block this feed or entry + * @return Boolean as to whether to block this feed or entry + */ + public boolean getBlock() { + return block; + } + + /** + * Boolean as to whether to block this feed or entry + * @param block Boolean as to whether to block this feed or entry + */ + public void setBlock(boolean block) { + this.block = block; + } + + /** + * Boolean as to whether this feed or entry contains adult content + * @return Boolean as to whether this feed or entry contains adult content + */ + public boolean getExplicit() { + return explicit; + } + + /** + * Boolean as to whether this feed or entry contains adult content + * @param explicit Boolean as to whether this feed or entry contains adult content + */ + public void setExplicit(boolean explicit) { + this.explicit = explicit; + } + + /** + * A list of keywords for this feed or entry + * + * Must not contain spaces + * @return A list of keywords for this feed or entry + */ + public String[] getKeywords() { + return keywords == null ? new String[0] : keywords; + } + + /** + * A list of keywords for this feed or entry + * + * Must not contain spaces + * @param keywords A list of keywords for this feed or enty + */ + public void setKeywords(String[] keywords) { + this.keywords = keywords; + } + + /** + * A subtitle for this feed or entry + * @return A subtitle for this feed or entry + */ + public String getSubtitle() { + return subtitle; + } + + /** + * A subtitle for this feed or entry + * @param subtitle A subtitle for this feed or entry + */ + public void setSubtitle(String subtitle) { + this.subtitle = subtitle; + } + + /** + * A subtitle for this feed or entry + * @return A subtitle for this feed or entry + */ + public String getSummary() { + return summary; + } + + /** + * A subtitle for this feed or entry + * @param summary A subtitle for this feed or entry + */ + public void setSummary(String summary) { + this.summary = summary; + } + + public String toString() { + StringBuffer sb = new StringBuffer("["); + sb.append(" Author: "); + sb.append(this.getAuthor()); + sb.append(" Block: "); + sb.append(this.getBlock()); + sb.append(" Explicit: "); + sb.append(this.getExplicit()); + sb.append(" Keywords: "); + + if (this.getKeywords() != null) { + for (int i = 0; i < keywords.length; i++) { + sb.append("'" + this.getKeywords()[i] + "'"); + } + } + + sb.append(" Subtitle: "); + sb.append(this.getSubtitle()); + sb.append(" Summary: "); + sb.append(this.getSummary()); + sb.append("]"); + + return sb.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/EntryInformation.java b/src/main/java/com/sun/syndication/feed/module/itunes/EntryInformation.java new file mode 100644 index 0000000..3d2ddb0 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/EntryInformation.java @@ -0,0 +1,67 @@ +/* + * EntryInformation.java + * + * Created on November 19, 2005, 10:56 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package com.sun.syndication.feed.module.itunes; + +import com.sun.syndication.feed.module.itunes.types.Duration; + + +/** + * This class contains information for iTunes podcast feeds that exist at the Item level. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.2 $ + * + */ +public interface EntryInformation extends ITunes{ + + /** + * Returns the Duration object for this Item + * @return Returns the Duration object for this Item + */ + public Duration getDuration(); + + /** + * Sets the Duration object for this Item + * @param duration Sets the Duration object for this Item + */ + public void setDuration(Duration duration) ; + +} diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/EntryInformationImpl.java b/src/main/java/com/sun/syndication/feed/module/itunes/EntryInformationImpl.java new file mode 100644 index 0000000..90ba3ea --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/EntryInformationImpl.java @@ -0,0 +1,119 @@ +/* + * EntryInformation.java + * + * Created on August 1, 2005, 7:37 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.itunes; + +import com.sun.syndication.feed.module.itunes.types.Duration; + + +/** + * This class contains information for iTunes podcast feeds that exist at the Item level. + * @version $Revision: 1.2 $ + * @author Robert "kebernet" Cooper + */ +public class EntryInformationImpl extends AbstractITunesObject implements EntryInformation { + private Duration duration; + + /** + * Creates a new instance of EntryInformationImpl + */ + public EntryInformationImpl() { + } + + /** + * Returns the Duration object for this Item + * @return Returns the Duration object for this Item + */ + public Duration getDuration() { + return duration; + } + + /** + * Sets the Duration object for this Item + * @param duration Sets the Duration object for this Item + */ + public void setDuration(Duration duration) { + this.duration = duration; + } + + /** + * Defined by the ROME module API + * @param obj Object to copy from + */ + public void copyFrom(Object obj) { + EntryInformationImpl info = (EntryInformationImpl) obj; + this.setAuthor(info.getAuthor()); + this.setBlock(info.getBlock()); + + if (info.getDuration() != null) { + this.setDuration(new Duration(info.getDuration().getMilliseconds())); + } + + this.setExplicit(info.getExplicit()); + + if (info.getKeywords() != null) { + this.setKeywords((String[]) info.getKeywords().clone()); + } + + this.setSubtitle(info.getSubtitle()); + this.setSummary(info.getSummary()); + } + + /** + * Required by the ROME API + * @return A clone of this module object + */ + public Object clone() { + EntryInformationImpl info = new EntryInformationImpl(); + info.copyFrom(this); + + return info; + } + + public String toString() { + StringBuffer sb = new StringBuffer("["); + sb.append(" Duration: "); + sb.append(this.getDuration()); + sb.append("]"); + sb.append(super.toString()); + + return sb.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/FeedInformation.java b/src/main/java/com/sun/syndication/feed/module/itunes/FeedInformation.java new file mode 100644 index 0000000..d69bdd0 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/FeedInformation.java @@ -0,0 +1,106 @@ +/* + * FeedInformation.java + * + * Created on November 19, 2005, 10:57 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.itunes; + +import java.net.URL; +import java.util.List; + + +/** + * This class contains information for iTunes podcast feeds that exist at the Channel level. + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.2 $ + */ +public interface FeedInformation extends ITunes { + + /** + * The parent categories for this feed + * @return The parent categories for this feed + */ + public List getCategories() ; + + /** + * The parent categories for this feed + * @param categories The parent categories for this feed + */ + public void setCategories(List categories); + + /** + * Sets the URL for the image. + * + * NOTE: To specification images should be in PNG or JPEG format. + * @param image Sets the URL for the image. + */ + public void setImage(URL image); + + /** + * Returns the URL for the image. + * + * NOTE: To specification images should be in PNG or JPEG format. + * @return Returns the URL for the image. + */ + public URL getImage(); + + /** + * Sets the owner email address for the feed. + * @param ownerEmailAddress Sets the owner email address for the feed. + */ + public void setOwnerEmailAddress(String ownerEmailAddress); + + /** + * Returns the owner email address for the feed. + * @return Returns the owner email address for the feed. + */ + public String getOwnerEmailAddress(); + + /** + * Sets the owner name for the feed + * @param ownerName Sets the owner name for the feed + */ + public void setOwnerName(String ownerName); + + /** + * Returns the owner name for the feed + * @return Returns the owner name for the feed + */ + public String getOwnerName(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/FeedInformationImpl.java b/src/main/java/com/sun/syndication/feed/module/itunes/FeedInformationImpl.java new file mode 100644 index 0000000..3a73632 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/FeedInformationImpl.java @@ -0,0 +1,197 @@ +/* + * FeedInformation.java + * + * Created on August 1, 2005, 7:11 PM + * + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.itunes; +import java.net.MalformedURLException; +import java.net.URL; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.logging.Logger; + + +/** + * This class contains information for iTunes podcast feeds that exist at the Channel level. + * @version $Revision: 1.2 $ + * @author Robert "kebernet" Cooper + */ +public class FeedInformationImpl extends AbstractITunesObject implements FeedInformation { + private String ownerName; + private String ownerEmailAddress; + private URL image; + private List categories; + + /** + * Creates a new instance of FeedInformationImpl + */ + public FeedInformationImpl() { + } + + /** + * The parent categories for this feed + * @return The parent categories for this feed + */ + public List getCategories() { + return (categories==null) ? (categories=new ArrayList()) : categories; + } + + /** + * The parent categories for this feed + * @param categories The parent categories for this feed + */ + public void setCategories(List categories) { + this.categories = categories; + } + + /** + * Returns the owner name for the feed + * @return Returns the owner name for the feed + */ + public String getOwnerName() { + return ownerName; + } + + /** + * Sets the owner name for the feed + * @param ownerName Sets the owner name for the feed + */ + public void setOwnerName(String ownerName) { + this.ownerName = ownerName; + } + + /** + * Returns the owner email address for the feed. + * @return Returns the owner email address for the feed. + */ + public String getOwnerEmailAddress() { + return ownerEmailAddress; + } + + /** + * Sets the owner email address for the feed. + * @param ownerEmailAddress Sets the owner email address for the feed. + */ + public void setOwnerEmailAddress(String ownerEmailAddress) { + this.ownerEmailAddress = ownerEmailAddress; + } + + /** + * Returns the URL for the image. + * + * NOTE: To specification images should be in PNG or JPEG format. + * @return Returns the URL for the image. + */ + public URL getImage() { + return image; + } + + /** + * Sets the URL for the image. + * + * NOTE: To specification images should be in PNG or JPEG format. + * @param image Sets the URL for the image. + */ + public void setImage(URL image) { + this.image = image; + } + + /** + * Required by the ROME API + * @param obj object to copy property values from + */ + public void copyFrom(Object obj) { + FeedInformationImpl info = (FeedInformationImpl) obj; + this.setAuthor(info.getAuthor()); + this.setBlock(info.getBlock()); + + this.getCategories().clear(); + if (info.getCategories() != null) { + this.getCategories().addAll(info.getCategories()); + } + + this.setExplicit(info.getExplicit()); + + try { + if (info.getImage() != null) { + this.setImage(new URL(info.getImage().toExternalForm())); + } + } catch (MalformedURLException e) { + Logger.getAnonymousLogger().fine("Error copying URL:" + info.getImage()); + } + + if (info.getKeywords() != null) { + this.setKeywords((String[]) info.getKeywords().clone()); + } + + this.setOwnerEmailAddress(info.getOwnerEmailAddress()); + this.setOwnerName(info.getOwnerName()); + this.setSubtitle(info.getSubtitle()); + this.setSummary(info.getSummary()); + } + + /** + * Returns a copy of this FeedInformationImpl object + * + * @return Returns a copy of this FeedInformationImpl object + */ + public Object clone() { + FeedInformationImpl info = new FeedInformationImpl(); + info.copyFrom(this); + + return info; + } + + public String toString() { + StringBuffer sb = new StringBuffer("["); + sb.append(" email: "); + sb.append(this.getOwnerEmailAddress()); + sb.append(" name: "); + sb.append(this.getOwnerName()); + sb.append(" image: "); + sb.append(this.getImage()); + sb.append(" categories: "); + sb.append(this.getCategories()); + sb.append("]"); + sb.append(super.toString()); + + return sb.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/ITunes.java b/src/main/java/com/sun/syndication/feed/module/itunes/ITunes.java new file mode 100644 index 0000000..5140806 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/ITunes.java @@ -0,0 +1,132 @@ +/* + * ITunes.java + * + * Created on November 19, 2005, 10:58 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.sun.syndication.feed.module.itunes; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.feed.module.itunes.types.Category; + +/** + * This interface contains the methods common to all iTunes module points. + * + * @author Robert "kebernet" Cooper + * @version $Revision: 1.3 $ + */ +public interface ITunes extends Module { + + public static final String URI = AbstractITunesObject.URI; + + /** + * Returns the author string for this feed or entry + * @return Returns the author string for this feed or entry + */ + public String getAuthor(); + + /** + * Sets the author string for this feed or entry + * @param author Sets the author string for this feed or entry + */ + public void setAuthor(String author) ; + + /** + * Boolean as to whether to block this feed or entry + * @return Boolean as to whether to block this feed or entry + */ + public boolean getBlock(); + + /** + * Boolean as to whether to block this feed or entry + * @param block Boolean as to whether to block this feed or entry + */ + public void setBlock(boolean block) ; + + /** + * Boolean as to whether this feed or entry contains adult content + * @return Boolean as to whether this feed or entry contains adult content + */ + public boolean getExplicit() ; + + /** + * Boolean as to whether this feed or entry contains adult content + * @param explicit Boolean as to whether this feed or entry contains adult content + */ + public void setExplicit(boolean explicit) ; + + /** + * A list of keywords for this feed or entry + * + * Must not contain spaces + * @return A list of keywords for this feed or entry + */ + public String[] getKeywords() ; + + /** + * A list of keywords for this feed or entry + * + * Must not contain spaces + * @param keywords A list of keywords for this feed or enty + */ + public void setKeywords(String[] keywords); + /** + * A subtitle for this feed or entry + * @return A subtitle for this feed or entry + */ + public String getSubtitle(); + + /** + * A subtitle for this feed or entry + * @param subtitle A subtitle for this feed or entry + */ + public void setSubtitle(String subtitle); + + + /** + * A subtitle for this feed or entry + * @return A subtitle for this feed or entry + */ + public String getSummary() ; + + /** + * A subtitle for this feed or entry + * @param summary A subtitle for this feed or entry + */ + public void setSummary(String summary); + +} diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/io/ITunesGenerator.java b/src/main/java/com/sun/syndication/feed/module/itunes/io/ITunesGenerator.java new file mode 100644 index 0000000..7a2bbd5 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/io/ITunesGenerator.java @@ -0,0 +1,182 @@ +/* + * ITunesGenerator.java + * + * Created on August 1, 2005, 10:44 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.itunes.io; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.feed.module.itunes.AbstractITunesObject; +import com.sun.syndication.feed.module.itunes.EntryInformationImpl; +import com.sun.syndication.feed.module.itunes.FeedInformationImpl; +import com.sun.syndication.feed.module.itunes.types.Category; +import com.sun.syndication.io.ModuleGenerator; + +import org.jdom.Element; +import org.jdom.Namespace; + +import java.util.HashSet; +import java.util.Iterator; + +/** + * @version $Revision: 1.3 $ + * @author Robert "kebernet" Cooper + */ +public class ITunesGenerator implements ModuleGenerator { + private static final HashSet SET = new HashSet(); + private static final Namespace NS = Namespace.getNamespace(AbstractITunesObject.PREFIX, AbstractITunesObject.URI); + + static { + SET.add(NS); + } + + /** Creates a new instance of ITunesGenerator */ + public ITunesGenerator() { + } + + public void generate(Module module, Element element) { + Element root = element; + + while ((root.getParent() != null) && root.getParent() instanceof Element) { + root = (Element) root.getParent(); + } + + root.addNamespaceDeclaration(NS); + + if (!(module instanceof AbstractITunesObject)) { + return; + } + + AbstractITunesObject itunes = (AbstractITunesObject) module; + + if (itunes instanceof FeedInformationImpl) { + //Do Channel Specific Stuff. + FeedInformationImpl info = (FeedInformationImpl) itunes; + Element owner = this.generateSimpleElement("owner", ""); + Element email = this.generateSimpleElement("email", info.getOwnerEmailAddress()); + owner.addContent(email); + + Element name = this.generateSimpleElement("name", info.getOwnerName()); + owner.addContent(name); + element.addContent(owner); + + if (info.getImage() != null) { + Element image = this.generateSimpleElement("image", ""); + image.setAttribute("href", info.getImage().toExternalForm()); + element.addContent(image); + } + + for (Iterator it = info.getCategories().iterator(); it.hasNext();) { + Category cat = (Category) it.next(); + Element category = this.generateSimpleElement("category", ""); + category.setAttribute("text", cat.getName()); + + if (cat.getSubcategory() != null) { + Element subcat = this.generateSimpleElement("category", ""); + subcat.setAttribute("text", cat.getSubcategory().getName()); + category.addContent(subcat); + } + + element.addContent(category); + } + } else if (itunes instanceof EntryInformationImpl) { + EntryInformationImpl info = (EntryInformationImpl) itunes; + + if (info.getDuration() != null) { + element.addContent(this.generateSimpleElement("duration", info.getDuration().toString())); + } + } + + if (itunes.getAuthor() != null) { + element.addContent(this.generateSimpleElement("author", itunes.getAuthor())); + } + + if (itunes.getBlock()) { + element.addContent(this.generateSimpleElement("block", "")); + } + + if (itunes.getExplicit()) { + element.addContent(this.generateSimpleElement("explicit", "yes")); + } else { + element.addContent(this.generateSimpleElement("explicit", "no")); + } + + if (itunes.getKeywords() != null) { + StringBuffer sb = new StringBuffer(); + + for (int i = 0; i < itunes.getKeywords().length; i++) { + if (i != 0) { + sb.append(", "); + } + + sb.append(itunes.getKeywords()[i]); + } + + element.addContent(this.generateSimpleElement("keywords", sb.toString())); + } + + if (itunes.getSubtitle() != null) { + element.addContent(this.generateSimpleElement("subtitle", itunes.getSubtitle())); + } + + if (itunes.getSummary() != null) { + element.addContent(this.generateSimpleElement("summary", itunes.getSummary())); + } + } + + /** Returns the list of namespaces this module uses. + * @return set of Namespace objects. + */ + public java.util.Set getNamespaces() { + return SET; + } + + /** Returns the namespace URI this module handles. + * @return Returns the namespace URI this module handles. + */ + public String getNamespaceUri() { + return AbstractITunesObject.URI; + } + + protected Element generateSimpleElement(String name, String value) { + Element element = new Element(name, NS); + element.addContent(value); + + return element; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/io/ITunesParser.java b/src/main/java/com/sun/syndication/feed/module/itunes/io/ITunesParser.java new file mode 100644 index 0000000..4d48304 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/io/ITunesParser.java @@ -0,0 +1,209 @@ +/* + * ITunesParser.java + * + * Created on August 1, 2005, 8:29 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + + */ +package com.sun.syndication.feed.module.itunes.io; + +import com.sun.syndication.feed.module.itunes.AbstractITunesObject; +import com.sun.syndication.feed.module.itunes.EntryInformationImpl; +import com.sun.syndication.feed.module.itunes.FeedInformationImpl; +import com.sun.syndication.io.ModuleParser; +import com.sun.syndication.feed.module.itunes.types.Category; +import com.sun.syndication.feed.module.itunes.types.Duration; +import com.sun.syndication.feed.module.itunes.types.Subcategory; +import com.sun.syndication.io.WireFeedParser; + +import org.jdom.Element; +import org.jdom.Namespace; + +import org.jdom.output.XMLOutputter; + +import java.net.MalformedURLException; +import java.net.URL; + +import java.util.Iterator; +import java.util.List; +import java.util.StringTokenizer; +import java.util.logging.Logger; + +/** + * @version $Revision: 1.10 $ + * @author Robert "kebernet" Cooper + */ +public class ITunesParser implements ModuleParser { + static Logger log = Logger.getLogger(ITunesParser.class.getName()); + Namespace ns = Namespace.getNamespace(AbstractITunesObject.URI); + + /** Creates a new instance of ITunesParser */ + public ITunesParser() { + } + + public void setParser(WireFeedParser feedParser) { + } + + public String getNamespaceUri() { + return AbstractITunesObject.URI; + } + + public com.sun.syndication.feed.module.Module parse(org.jdom.Element element) { + AbstractITunesObject module = null; + + if (element.getName().equals("channel")) { + FeedInformationImpl feedInfo = new FeedInformationImpl(); + module = feedInfo; + + //Now I am going to get the channel specific tags + Element owner = element.getChild("owner", ns); + + if (owner != null) { + Element name = owner.getChild("name", ns); + + if (name != null) { + feedInfo.setOwnerName(name.getValue().trim()); + } + + Element email = owner.getChild("email", ns); + + if (email != null) { + feedInfo.setOwnerEmailAddress(email.getValue().trim()); + } + } + + Element image = element.getChild("image", ns); + + if ((image != null) && (image.getAttributeValue("href") != null)) { + try { + URL imageURL = new URL(image.getAttributeValue("href").trim()); + feedInfo.setImage(imageURL); + } catch (MalformedURLException e) { + log.finer("Malformed URL Exception reading itunes:image tag: " + image.getAttributeValue("href")); + } + } + + List categories = element.getChildren("category", ns); + for (Iterator it = categories.iterator(); it.hasNext();) { + Element category = (Element) it.next(); + if ((category != null) && (category.getAttribute("text") != null)) { + Category cat = new Category(); + cat.setName(category.getAttribute("text").getValue().trim()); + + Element subcategory = category.getChild("category", ns); + + if (subcategory != null && subcategory.getAttribute("text") != null) { + Subcategory subcat = new Subcategory(); + subcat.setName(subcategory.getAttribute("text").getValue().trim()); + cat.setSubcategory(subcat); + } + + feedInfo.getCategories().add(cat); + } + } + + } else if (element.getName().equals("item")) { + EntryInformationImpl entryInfo = new EntryInformationImpl(); + module = entryInfo; + + //Now I am going to get the item specific tags + + Element duration = element.getChild("duration", ns); + + if (duration != null && duration.getValue() != null ) { + Duration dur = new Duration(duration.getValue().trim()); + entryInfo.setDuration(dur); + } + } + if (module != null) { + //All these are common to both Channel and Item + Element author = element.getChild("author", ns); + + if (author != null && author.getText() != null ) { + module.setAuthor(author.getText()); + } + + Element block = element.getChild("block", ns); + + if (block != null) { + module.setBlock(true); + } + + Element explicit = element.getChild("explicit", ns); + + if ((explicit != null) && explicit.getValue() != null + && explicit.getValue().trim().equalsIgnoreCase("yes")) { + module.setExplicit(true); + } + + Element keywords = element.getChild("keywords", ns); + + if (keywords != null) { + StringTokenizer tok = new StringTokenizer(getXmlInnerText(keywords).trim(), ","); + String[] keywordsArray = new String[tok.countTokens()]; + + for (int i = 0; tok.hasMoreTokens(); i++) { + keywordsArray[i] = tok.nextToken(); + } + + module.setKeywords(keywordsArray); + } + + Element subtitle = element.getChild("subtitle", ns); + + if (subtitle != null) { + module.setSubtitle(subtitle.getTextTrim()); + } + + Element summary = element.getChild("summary", ns); + + if (summary != null) { + module.setSummary(summary.getTextTrim()); + } + } + + return module; + } + + protected String getXmlInnerText(Element e) { + StringBuffer sb = new StringBuffer(); + XMLOutputter xo = new XMLOutputter(); + List children = e.getContent(); + sb.append(xo.outputString(children)); + + return sb.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/io/ITunesParserOldNamespace.java b/src/main/java/com/sun/syndication/feed/module/itunes/io/ITunesParserOldNamespace.java new file mode 100644 index 0000000..87aa686 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/io/ITunesParserOldNamespace.java @@ -0,0 +1,43 @@ +/* + * ITunesParserOldNamespace.java + * + * Created on April 23, 2006, 2:09 AM + * + * Copyright Robert Cooper, Temple of the Screaming Penguin + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + */ + +package com.sun.syndication.feed.module.itunes.io; + +import org.jdom.Namespace; +import com.sun.syndication.io.WireFeedParser; + +/** + * + * @author Robert "kebernet" Cooper + */ +public class ITunesParserOldNamespace extends ITunesParser{ + String URI = "http://www.itunes.com/DTDs/Podcast-1.0.dtd"; + + /** Creates a new instance of ITunesParserOldNamespace */ + public ITunesParserOldNamespace() { + super(); + super.ns = Namespace.getNamespace( URI ); + } + + public String getNamespaceUri() { + return URI; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/package.html b/src/main/java/com/sun/syndication/feed/module/itunes/package.html new file mode 100644 index 0000000..a618e26 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/package.html @@ -0,0 +1,74 @@ + + + + + + + + + This is a ROME plug in that implements the iTunes RSS extensions as defined + by Apple in their + documentation. BTW, an anti-shoutout to Apple for moving the original + PDF spec + . Thanks for making it harder than it needed to be. + +

Sample Usage:

+ 
+        SyndFeedInput input = new SyndFeedInput();
+        SyndFeed syndfeed = input.build(new XmlReader(feed.toURL()));
+
+        Module module = syndfeed.getModule("http://www.itunes.com/DTDs/Podcast-1.0.dtd");
+        FeedInformation feedInfo = (FeedInformation) module;
+        
+        System.out.println( feedInfo.getImage() );
+        System.out.println( feedInfo.getCategory() );
+        
+        // Or to create a feed..
+        
+        ArrayList modules = new ArrayList();
+        EntryInformation e = new EntryInformationImpl();
+        e.setDuration( new Duration( 10000 ) );
+        modules.add( e );
+        syndEntry.setModules( modules );
+
+ + Similarly you can get an EntryInformation object off SyndEntries or Items. + + + 
+ * This library is provided under dual licenses.
+ * You may choose the terms of the Lesser General Public License or the Apache
+ * License at your discretion.
+ *
+ *  Copyright (C) 2005  Robert Cooper, Temple of the Screaming Penguin
+ *
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+
+ + diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/types/Category.java b/src/main/java/com/sun/syndication/feed/module/itunes/types/Category.java new file mode 100644 index 0000000..c27d0f4 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/types/Category.java @@ -0,0 +1,123 @@ +/* + * Category.java + * + * Created on August 1, 2005, 7:24 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.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. + * @version $Revision: 1.2 $ + * @author Robert "kebernet" Cooper + */ +public class Category implements Serializable { + private String name; + private Subcategory subcategory; + + /** Creates a new instance of Category */ + public Category() { + } + + /** Creates a new instance of Category with a given name. + * @param name Name of the category. + */ + public Category(String name) { + this.setName(name); + } + + /** + * Returns the name of the category + * @return Returns the name of the category + */ + public String getName() { + return name; + } + + /** + * Sets the name of the category + * @param name Sets the name of the category + */ + public void setName(String name) { + this.name = name; + } + + /** + * Returns the Subcategory object for this category + * @return Returns the Subcategory object for this category + */ + public Subcategory getSubcategory() { + return subcategory; + } + + /** + * Sets the Subcategory object for this category + * @param subcategory Sets the Subcategory object for this category + */ + public void setSubcategory(Subcategory subcategory) { + this.subcategory = subcategory; + } + + /** + * Returns a copy of this category. + * @return Returns a copy of this category. + */ + public Object clone() { + Category c = new Category(); + c.setName(this.getName()); + + if (this.getSubcategory() != null) { + c.setSubcategory((Subcategory) this.getSubcategory().clone()); + } + + return c; + } + + public String toString() { + StringBuffer sb = new StringBuffer(this.getName()); + + if (this.getSubcategory() != null) { + sb.append(" -> " + this.getSubcategory().toString()); + } + + return sb.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/types/Duration.java b/src/main/java/com/sun/syndication/feed/module/itunes/types/Duration.java new file mode 100644 index 0000000..df8a412 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/types/Duration.java @@ -0,0 +1,157 @@ +/* + * Duration.java + * + * Created on August 1, 2005, 7:45 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.itunes.types; + +import java.text.NumberFormat; +import java.util.StringTokenizer; +import java.io.Serializable; + +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. + * @version $Revision: 1.7 $ + * @author Robert "kebernet" Cooper + */ +public class Duration implements Serializable { + static final long SECOND = 1000; + static final long MINUTE = SECOND * 60; + static final long HOUR = MINUTE * 60; + static final NumberFormat NUM_FORMAT = NumberFormat.getNumberInstance(); + static{ + NUM_FORMAT.setMinimumFractionDigits(0); + NUM_FORMAT.setMaximumFractionDigits(0); + NUM_FORMAT.setMinimumIntegerDigits(2); + NUM_FORMAT.setGroupingUsed(false); + } + private long milliseconds; + + /** + * Creates a new Duration object with 0 length. + */ + public Duration() { + super(); + } + + /** + * Creates a new instance of Duration specifying a length in milliseconds + * @param milliseconds Creates a new instance of Duration specifying a length in milliseconds + */ + public Duration(final long milliseconds) { + this.setMilliseconds(milliseconds); + } + + /** + * Creates a new duration object with the given hours, minutes and seconds + * @param hours number of hours + * @param minutes number of minutes + * @param seconds number of seconds + */ + public Duration(final int hours, final int minutes, final float seconds) { + this.setMilliseconds((hours * HOUR) + (minutes * MINUTE) + + (long)(seconds * SECOND)); + } + + /** + * Creates a new Duration parsing the String value. + * @param duration A String to parse + */ + public Duration( final String duration ){ + StringTokenizer tok = new StringTokenizer( duration, ":" ); + switch (tok.countTokens() ){ + case 1: + this.setMilliseconds( (long) (NumberParser.parseFloat(tok.nextToken(), 0f) * SECOND) ); + break; + case 2: + this.setMilliseconds(NumberParser.parseLong( tok.nextToken(), 0l ) * MINUTE + (long) (NumberParser.parseFloat(tok.nextToken(), 0f) * SECOND) ); + break; + case 3: + this.setMilliseconds(NumberParser.parseLong(tok.nextToken(), 0l) * HOUR + NumberParser.parseLong(tok.nextToken(), 0l) * MINUTE + (long) (NumberParser.parseFloat(tok.nextToken(), 0f) * SECOND) ); + break; + default: + throw new RuntimeException("Illegal time value: "+ duration); + } + } + + /** + * Returns a String representation in the formation HH:MM:SS + * @return Returns a String representation in the formation HH:MM:SS + */ + public String toString() { + Time time = new Time(); + + + return NUM_FORMAT.format(time.hours) + ":" + NUM_FORMAT.format(time.minutes) + ":" + + NUM_FORMAT.format( Math.round(time.seconds) ); + } + + /** + * Returns the millisecond length + * @return the millisecond length + */ + public long getMilliseconds() { + return milliseconds; + } + + /** + * Sets the millisecond length + * @param milliseconds the millisecond length + */ + public void setMilliseconds(long milliseconds) { + this.milliseconds = milliseconds; + } + + private class Time { + int hours; + int minutes; + float seconds; + + public Time() { + long time = getMilliseconds(); + hours = (int) (time / HOUR); + time = time - (long) hours * HOUR; + minutes = (int) (time / MINUTE); + time = time - (long) minutes * MINUTE; + seconds = (float) ( (float) time / (float) SECOND); + } + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/types/Subcategory.java b/src/main/java/com/sun/syndication/feed/module/itunes/types/Subcategory.java new file mode 100644 index 0000000..ecfe4b5 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/types/Subcategory.java @@ -0,0 +1,99 @@ +/* + * SubCategory.java + * + * Created on August 1, 2005, 7:24 PM + * + * This library is provided under dual licenses. + * You may choose the terms of the Lesser General Public License or the Apache + * License at your discretion. + * + * Copyright (C) 2005 Robert Cooper, Temple of the Screaming Penguin + * + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.itunes.types; + +import java.io.Serializable; + + +/** + * This class represents a Subcategor of a Category. + * @author Robert "kebernet" Cooper + * @version $Revision: 1.2 $ + */ +public class Subcategory implements Serializable { + private String name; + + /** Creates a new instance of SubCategory */ + public Subcategory() { + } + + /** Creates a new instance of Category with a given name. + * @param name Name of the category. + */ + public Subcategory(String name) { + this.setName(name); + } + + /** + * Returns the name of the subcategory. + * @return Returns the name of the subcategory. + */ + public String getName() { + return name; + } + + /** + * Set the name of the subcategory. + * @param name Set the name of the subcategory. + */ + public void setName(String name) { + this.name = name; + } + + /** + * Clones the object. + * @return Clone of the object. + */ + public Object clone() { + Subcategory sc = new Subcategory(); + sc.setName(this.getName()); + + return sc; + } + + /** + * String representation of the object. + * @return String representation of the object. + */ + public String toString() { + return new StringBuffer(this.getName()).toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/itunes/types/package.html b/src/main/java/com/sun/syndication/feed/module/itunes/types/package.html new file mode 100644 index 0000000..98e5105 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/itunes/types/package.html @@ -0,0 +1,47 @@ + + + + + + + + This package contains data types for use wit the iTunes plug in. + + 
+ * This library is provided under dual licenses.
+ * You may choose the terms of the Lesser General Public License or the Apache
+ * License at your discretion.
+ *
+ *  Copyright (C) 2005  Robert Cooper, Temple of the Screaming Penguin
+ *
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+
+ + + diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/MediaEntryModule.java b/src/main/java/com/sun/syndication/feed/module/mediarss/MediaEntryModule.java new file mode 100644 index 0000000..2db9300 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/MediaEntryModule.java @@ -0,0 +1,45 @@ +/* + * MediaEntryModule.java + * + * Created on April 19, 2006, 1:15 AM + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss; + +import com.sun.syndication.feed.module.mediarss.types.MediaContent; +import com.sun.syndication.feed.module.mediarss.types.MediaGroup; + + +/** + * Represents entry/item level information. + * @author cooper + */ +public interface MediaEntryModule extends MediaModule { + /** + * Returns the MediaContent items for the entry. + * @return Returns the MediaContent items for the entry. + */ + public MediaContent[] getMediaContents(); + + /** + * Returns the media groups for the entry. + * @return Returns the media groups for the entry. + */ + public MediaGroup[] getMediaGroups(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/MediaEntryModuleImpl.java b/src/main/java/com/sun/syndication/feed/module/mediarss/MediaEntryModuleImpl.java new file mode 100644 index 0000000..5e6592b --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/MediaEntryModuleImpl.java @@ -0,0 +1,116 @@ +/* + * Copyright 2006 Nathanial X. Freitas, openvision.tv + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.mediarss; + +import java.io.Serializable; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; +import com.sun.syndication.feed.module.mediarss.types.MediaContent; +import com.sun.syndication.feed.module.mediarss.types.MediaGroup; +import com.sun.syndication.feed.module.mediarss.types.Metadata; + + +/** + * Represents information for an Entry/Item level. + * @author Nathanial X. Freitas + */ +public class MediaEntryModuleImpl extends MediaModuleImpl + implements MediaEntryModule, Cloneable, Serializable { + private static final long serialVersionUID = -1564409507033924835L; + + /* + * 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]; + + /** + * Creates a new instance. + */ + public MediaEntryModuleImpl() { + super(MediaEntryModule.class, MediaModule.URI); + } + + /** + * MediaContent items for the entry + * @param mediaContents MediaContent items for the entry + */ + public void setMediaContents(MediaContent[] mediaContents) { + this.mediaContents = (mediaContents == null) ? new MediaContent[0] + : mediaContents; + } + + /** + * MediaContent items for the entry + * @return MediaContent items for the entry + */ + public MediaContent[] getMediaContents() { + return mediaContents; + } + + /** + * MediaGroups for the entry + * @param mediaGroups MediaGroups for the entry + */ + public void setMediaGroups(MediaGroup[] mediaGroups) { + this.mediaGroups = (mediaGroups == null) ? new MediaGroup[0] : mediaGroups; + } + + /** + * MediaGroups for the entry + * @return MediaGroups for the entry + */ + public MediaGroup[] getMediaGroups() { + return mediaGroups; + } + + public Object clone() { + MediaEntryModuleImpl m = new MediaEntryModuleImpl(); + m.setMediaContents((MediaContent[]) mediaContents.clone()); + m.setMediaGroups((MediaGroup[]) mediaGroups.clone()); + m.setMetadata((getMetadata() == null) ? null + : (Metadata) getMetadata().clone()); + m.setPlayer(getPlayer()); + + return m; + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(MediaEntryModuleImpl.class, this); + + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(MediaEntryModuleImpl.class, this); + + return equals.beanHashCode(); + } + + public String toString() { + ToStringBean tsBean = new ToStringBean(MediaEntryModuleImpl.class, this); + + return tsBean.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/MediaModule.java b/src/main/java/com/sun/syndication/feed/module/mediarss/MediaModule.java new file mode 100644 index 0000000..02b18cc --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/MediaModule.java @@ -0,0 +1,51 @@ +/* + * Copyright 2006 Nathanial X. Freitas, openvision.tv + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.mediarss; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.feed.module.mediarss.types.Metadata; +import com.sun.syndication.feed.module.mediarss.types.PlayerReference; + + +/** + * This is the base module for MediaRSS. + *

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.

+ * @author Nathanial X. Freitas + */ +public interface MediaModule extends Module { + //the URI of the MediaRSS specification as hosted by yahoo + public final static String URI = "http://search.yahoo.com/mrss/"; + + /** + * Returns Metadata associated with the feed. + * @return Returns Metadata associated with the feed. + */ + public Metadata getMetadata(); + + /** + * Returns a player reference associated with the feed. + * @return Returns a player reference associated with the feed. + */ + public PlayerReference getPlayer(); +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/MediaModuleImpl.java b/src/main/java/com/sun/syndication/feed/module/mediarss/MediaModuleImpl.java new file mode 100644 index 0000000..28318d7 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/MediaModuleImpl.java @@ -0,0 +1,110 @@ +/* + * MediaModuleImpl.java + * + * Created on April 19, 2006, 1:17 AM + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss; + +import java.io.Serializable; + +import com.sun.syndication.feed.module.ModuleImpl; +import com.sun.syndication.feed.module.mediarss.types.Metadata; +import com.sun.syndication.feed.module.mediarss.types.PlayerReference; + + +/** + * + * This class represents feed/channel level elements for MediaRSS + * @author cooper + */ +public class MediaModuleImpl extends ModuleImpl implements MediaModule, Serializable { + private static final long serialVersionUID = 1506805082848531979L; + + private Metadata metadata; + private PlayerReference player; + + /** Creates a new instance of MediaModuleImpl */ + public MediaModuleImpl() { + this(MediaModule.class, MediaModule.URI); + } + + /** + * constructor that passes values up to ModuleImpl. + * @param clazz + * @param uri + */ + public MediaModuleImpl(Class clazz, String uri) { + super(clazz, uri); + } + + public Class getInterface() { + return MediaModule.class; + } + + /** + * Metadata for a feed. + * @param metadata Metadata for a feed. + */ + public void setMetadata(Metadata metadata) { + this.metadata = metadata; + } + + /** + * Metadata for a feed. + * @return Metadata for a feed. + */ + public Metadata getMetadata() { + return metadata; + } + + /** + * Player for a feed. + * @param player Player for a feed. + */ + public void setPlayer(PlayerReference player) { + this.player = player; + } + + /** + * Player for a feed. + * @return Player for a feed. + */ + public PlayerReference getPlayer() { + return player; + } + + public String getUri() { + return MediaModule.URI; + } + + public Object clone() { + MediaModuleImpl m = new MediaModuleImpl(); + m.setMetadata((Metadata) metadata.clone()); + m.setPlayer(player); + + return m; + } + + public void copyFrom(Object obj) { + MediaModule m = (MediaModule) obj; + this.metadata = (Metadata) m.getMetadata().clone(); + this.player = m.getPlayer(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/io/AlternateMediaModuleParser.java b/src/main/java/com/sun/syndication/feed/module/mediarss/io/AlternateMediaModuleParser.java new file mode 100644 index 0000000..d184a79 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/io/AlternateMediaModuleParser.java @@ -0,0 +1,35 @@ +/* + * AlternateMediaModuleParser.java + * + * Created on August 20, 2006, 5:52 PM + * + * To change this template, choose Tools | Template Manager + * and open the template in the editor. + */ + +package com.sun.syndication.feed.module.mediarss.io; + +import org.jdom.Namespace; + +/** + * + * @author cooper + */ +public class AlternateMediaModuleParser extends MediaModuleParser { + + private static final Namespace NS = Namespace.getNamespace("http://search.yahoo.com/mrss"); + + + /** Creates a new instance of AlternateMediaModuleParser */ + public AlternateMediaModuleParser() { + super(); + } + + public String getNamespaceUri() { + return "http://search.yahoo.com/mrss"; + } + + public Namespace getNS(){ + return AlternateMediaModuleParser.NS; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/io/MediaModuleGenerator.java b/src/main/java/com/sun/syndication/feed/module/mediarss/io/MediaModuleGenerator.java new file mode 100644 index 0000000..b912dfd --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/io/MediaModuleGenerator.java @@ -0,0 +1,261 @@ +/* + * Copyright 2006 Nathanial X. Freitas, openvision.tv + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.mediarss.io; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.feed.module.mediarss.MediaEntryModule; +import com.sun.syndication.feed.module.mediarss.MediaModule; +import com.sun.syndication.feed.module.mediarss.types.Category; +import com.sun.syndication.feed.module.mediarss.types.Credit; +import com.sun.syndication.feed.module.mediarss.types.MediaContent; +import com.sun.syndication.feed.module.mediarss.types.MediaGroup; +import com.sun.syndication.feed.module.mediarss.types.Metadata; +import com.sun.syndication.feed.module.mediarss.types.PlayerReference; +import com.sun.syndication.feed.module.mediarss.types.Rating; +import com.sun.syndication.feed.module.mediarss.types.Restriction; +import com.sun.syndication.feed.module.mediarss.types.Text; +import com.sun.syndication.feed.module.mediarss.types.Thumbnail; +import com.sun.syndication.feed.module.mediarss.types.UrlReference; +import com.sun.syndication.io.*; + +import org.jdom.Element; +import org.jdom.Namespace; + +import java.util.HashSet; +import java.util.Set; + + +//this class TBI +public class MediaModuleGenerator implements ModuleGenerator { + private static final Namespace NS = Namespace.getNamespace("media", + MediaModule.URI); + private static final Set NAMESPACES = new HashSet(); + + static { + NAMESPACES.add(NS); + } + + public String getNamespaceUri() { + return MediaModule.URI; + } + + public Set getNamespaces() { + return NAMESPACES; + } + + public void generate(Module module, Element element) { + if (module instanceof MediaModule) { + MediaModule m = (MediaModule) module; + this.generateMetadata(m.getMetadata(), element); + this.generatePlayer(m.getPlayer(), element); + } + + if (module instanceof MediaEntryModule) { + MediaEntryModule m = (MediaEntryModule) module; + MediaGroup[] g = m.getMediaGroups(); + + for (int i = 0; i < g.length; i++) { + this.generateGroup(g[i], element); + } + + MediaContent[] c = m.getMediaContents(); + + for (int i = 0; i < c.length; i++) { + this.generateContent(c[i], element); + } + } + } + + public void generateContent(MediaContent c, Element e) { + Element mc = new Element("content", NS); + this.addNotNullAttribute(mc, "medium", c.getMedium()); + this.addNotNullAttribute(mc, "channels", c.getAudioChannels()); + this.addNotNullAttribute(mc, "bitrate", c.getBitrate()); + this.addNotNullAttribute(mc, "duration", c.getDuration()); + this.addNotNullAttribute(mc, "expression", c.getExpression()); + this.addNotNullAttribute(mc, "fileSize", c.getFileSize()); + this.addNotNullAttribute(mc, "framerate", c.getFramerate()); + this.addNotNullAttribute(mc, "height", c.getHeight()); + this.addNotNullAttribute(mc, "lang", c.getLanguage()); + this.addNotNullAttribute(mc, "samplingrate", c.getSamplingrate()); + this.addNotNullAttribute(mc, "type", c.getType()); + this.addNotNullAttribute(mc, "width", c.getWidth()); + + if (c.isDefaultContent()) { + this.addNotNullAttribute(mc, "isDefault", "true"); + } + + if (c.getReference() instanceof UrlReference) { + this.addNotNullAttribute(mc, "url", c.getReference()); + this.generatePlayer(c.getPlayer(), mc); + } else { + this.generatePlayer(c.getPlayer(), mc); + } + + this.generateMetadata(c.getMetadata(), mc); + e.addContent(mc); + } + + public void generateGroup(MediaGroup g, Element e) { + Element t = new Element("group", NS); + MediaContent[] c = g.getContents(); + + for (int i = 0; i < c.length; i++) { + this.generateContent(c[i], t); + } + + this.generateMetadata(g.getMetadata(), t); + e.addContent(t); + } + + public void generateMetadata(Metadata m, Element e) { + if (m == null) { + return; + } + + Category[] cats = m.getCategories(); + + for (int i = 0; i < cats.length; i++) { + Element c = generateSimpleElement("category", cats[i].getValue()); + this.addNotNullAttribute(c, "scheme", cats[i].getScheme()); + this.addNotNullAttribute(c, "label", cats[i].getLabel()); + e.addContent(c); + } + + Element copyright = addNotNullElement(e, "copyright", m.getCopyright()); + this.addNotNullAttribute(copyright, "url", m.getCopyrightUrl()); + + Credit[] creds = m.getCredits(); + + for (int i = 0; i < creds.length; i++) { + Element c = generateSimpleElement("credit", creds[i].getName()); + this.addNotNullAttribute(c, "role", creds[i].getRole()); + this.addNotNullAttribute(c, "scheme", creds[i].getScheme()); + e.addContent(c); + } + + Element desc = addNotNullElement(e, "description", m.getDescription()); + this.addNotNullAttribute(desc, "type", m.getDescriptionType()); + + if (m.getHash() != null) { + Element hash = this.addNotNullElement(e, "hash", + m.getHash().getValue()); + this.addNotNullAttribute(hash, "algo", m.getHash().getAlgorithm()); + } + + String[] keywords = m.getKeywords(); + + if (keywords.length > 0) { + String keyword = keywords[0]; + + for (int i = 1; i < keywords.length; i++) { + keyword += (", " + keywords[i]); + } + + this.addNotNullElement(e, "keywords", keyword); + } + + Rating[] rats = m.getRatings(); + + for (int i = 0; i < rats.length; i++) { + Element rat = this.addNotNullElement(e, "rating", rats[i].getValue()); + this.addNotNullAttribute(rat, "scheme", rats[i].getScheme()); + + if (rats[i].equals(Rating.ADULT)) { + this.addNotNullElement(e, "adult", "true"); + } else if (rats[i].equals(Rating.NONADULT)) { + this.addNotNullElement(e, "adult", "false"); + } + } + + Text[] text = m.getText(); + + for (int i = 0; i < text.length; i++) { + Element t = this.addNotNullElement(e, "text", text[i].getValue()); + this.addNotNullAttribute(t, "type", text[i].getType()); + this.addNotNullAttribute(t, "start", text[i].getStart()); + this.addNotNullAttribute(t, "end", text[i].getEnd()); + } + + Thumbnail[] thumbs = m.getThumbnail(); + + for (int i = 0; i < thumbs.length; i++) { + Element t = new Element("thumbnail", NS); + this.addNotNullAttribute(t, "url", thumbs[i].getUrl()); + this.addNotNullAttribute(t, "width", thumbs[i].getWidth()); + this.addNotNullAttribute(t, "height", thumbs[i].getHeight()); + this.addNotNullAttribute(t, "time", thumbs[i].getTime()); + e.addContent(t); + } + + Element title = this.addNotNullElement(e, "title", m.getTitle()); + this.addNotNullAttribute(title, "type", m.getTitleType()); + + Restriction[] r = m.getRestrictions(); + + for (int i = 0; i < r.length; i++) { + Element res = this.addNotNullElement(e, "restriction", + r[i].getValue()); + this.addNotNullAttribute(res, "type", r[i].getType()); + this.addNotNullAttribute(res, "relationship", r[i].getRelationship()); + } + } + + public void generatePlayer(PlayerReference p, Element e) { + if (p == null) { + return; + } + + Element t = new Element("player", NS); + this.addNotNullAttribute(t, "url", p.getUrl()); + this.addNotNullAttribute(t, "width", p.getWidth()); + this.addNotNullAttribute(t, "height", p.getHeight()); + e.addContent(t); + } + + protected void addNotNullAttribute(Element target, String name, Object value) { + if ((target == null) || (value == null)) { + return; + } else { + target.setAttribute(name, value.toString()); + } + } + + protected Element addNotNullElement(Element target, String name, + Object value) { + if (value == null) { + return null; + } else { + Element e = generateSimpleElement(name, value.toString()); + target.addContent(e); + + return e; + } + } + + protected Element generateSimpleElement(String name, String value) { + Element element = new Element(name, NS); + element.addContent(value); + + return element; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/io/MediaModuleParser.java b/src/main/java/com/sun/syndication/feed/module/mediarss/io/MediaModuleParser.java new file mode 100644 index 0000000..d753d2b --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/io/MediaModuleParser.java @@ -0,0 +1,477 @@ +/* + * Copyright 2006 Nathanial X. Freitas, openvision.tv + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.mediarss.io; + +import com.sun.syndication.feed.module.Module; +import com.sun.syndication.feed.module.mediarss.MediaEntryModuleImpl; +import com.sun.syndication.feed.module.mediarss.MediaModule; +import com.sun.syndication.feed.module.mediarss.MediaModuleImpl; +import com.sun.syndication.feed.module.mediarss.types.Category; +import com.sun.syndication.feed.module.mediarss.types.Credit; +import com.sun.syndication.feed.module.mediarss.types.Expression; +import com.sun.syndication.feed.module.mediarss.types.Hash; +import com.sun.syndication.feed.module.mediarss.types.MediaContent; +import com.sun.syndication.feed.module.mediarss.types.MediaGroup; +import com.sun.syndication.feed.module.mediarss.types.Metadata; +import com.sun.syndication.feed.module.mediarss.types.PlayerReference; +import com.sun.syndication.feed.module.mediarss.types.Rating; +import com.sun.syndication.feed.module.mediarss.types.Restriction; +import com.sun.syndication.feed.module.mediarss.types.Text; +import com.sun.syndication.feed.module.mediarss.types.Thumbnail; +import com.sun.syndication.feed.module.mediarss.types.Time; +import com.sun.syndication.feed.module.mediarss.types.UrlReference; +import com.sun.syndication.io.ModuleParser; +import com.sun.syndication.io.impl.NumberParser; + +import java.net.URI; + +import org.jdom.Element; +import org.jdom.Namespace; + + +import java.util.ArrayList; +import java.util.List; +import java.util.StringTokenizer; +import java.util.logging.Level; +import java.util.logging.Logger; + + +/** + * @author Nathanial X. Freitas + * + */ +public class MediaModuleParser implements ModuleParser { + private static final Logger LOG = Logger.getLogger(MediaModuleParser.class.getName()); + + /* + * Namespace instance for this URI. + */ + private static final Namespace NS = Namespace.getNamespace(MediaModule.URI); + + /* (non-Javadoc) + * @see com.sun.syndication.io.ModuleParser#getNamespaceUri() + */ + public String getNamespaceUri() { + // TODO Auto-generated method stub + return MediaModule.URI; + } + + /* (non-Javadoc) + * @see com.sun.syndication.io.ModuleParser#parse(org.jdom.Element) + */ + public Module parse(Element mmRoot) { + MediaModuleImpl mod = null; + + if (mmRoot.getName().equals("channel") || + mmRoot.getName().equals("feed")) { + mod = new MediaModuleImpl(); + } else { + mod = new MediaEntryModuleImpl(); + } + + mod.setMetadata(parseMetadata(mmRoot)); + mod.setPlayer(parsePlayer(mmRoot)); + + if (mod instanceof MediaEntryModuleImpl) { + MediaEntryModuleImpl m = (MediaEntryModuleImpl) mod; + m.setMediaContents(parseContent(mmRoot)); + m.setMediaGroups(parseGroup(mmRoot)); + } + + return mod; + } + + private MediaContent[] parseContent(Element e) { + List contents = e.getChildren("content", getNS()); + ArrayList values = new ArrayList(); + + try { + for (int i = 0; (contents != null) && (i < contents.size()); i++) { + Element content = (Element) contents.get(i); + MediaContent mc = null; + + if (content.getAttributeValue("url") != null) { + try{ + mc = new MediaContent(new UrlReference( + new URI(content.getAttributeValue("url")))); + mc.setPlayer(parsePlayer(content)); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing content tag.", ex); + } + } else { + mc = new MediaContent(parsePlayer(content)); + } + if (mc != null) { + values.add(mc); + try{ + mc.setAudioChannels((content.getAttributeValue("channels") == null) + ? null : new Integer(content.getAttributeValue("channels"))); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing content tag.", ex); + } + try{ + mc.setBitrate((content.getAttributeValue("bitrate") == null) + ? null : new Float(content.getAttributeValue("bitrate"))); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing content tag.", ex); + } + try{ + mc.setDuration((content.getAttributeValue("duration") == null) + ? null : new Long(content.getAttributeValue("duration"))); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing content tag.", ex); + } + + mc.setMedium(content.getAttributeValue("medium")); + + String expression = content.getAttributeValue("expression"); + + if (expression != null) { + if (expression.equalsIgnoreCase("full")) { + mc.setExpression(Expression.FULL); + } else if (expression.equalsIgnoreCase("sample")) { + mc.setExpression(Expression.SAMPLE); + } else if (expression.equalsIgnoreCase("nonstop")) { + mc.setExpression(Expression.NONSTOP); + } + } + + try{ + mc.setFileSize((content.getAttributeValue("fileSize") == null) + ? null : NumberParser.parseLong(content.getAttributeValue("fileSize"))); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing content tag.", ex); + } + try{ + mc.setFramerate((content.getAttributeValue("framerate") == null) + ? null : NumberParser.parseFloat(content.getAttributeValue("framerate"))); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing content tag.", ex); + } + try { + mc.setHeight((content.getAttributeValue("height") == null) + ? null : NumberParser.parseInt(content.getAttributeValue("height"))); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing content tag.", ex); + } + + mc.setLanguage(content.getAttributeValue("lang")); + mc.setMetadata(parseMetadata(content)); + try{ + mc.setSamplingrate((content.getAttributeValue("samplingrate") == null) + ? null : NumberParser.parseFloat(content.getAttributeValue("samplingrate"))); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing content tag.", ex); + } + + mc.setType(content.getAttributeValue("type")); + try{ + mc.setWidth((content.getAttributeValue("width") == null) ? null + : NumberParser.parseInt(content.getAttributeValue("width"))); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing content tag.", ex); + } + + mc.setDefaultContent((content.getAttributeValue("isDefault") == null) + ? false + : Boolean.getBoolean(content.getAttributeValue( + "isDefault"))); + } else { + LOG.log(Level.WARNING, "Could not find MediaContent."); + } + + + + } + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing content tag.", ex); + } + + return (MediaContent[]) values.toArray(new MediaContent[values.size()]); + } + + private MediaGroup[] parseGroup(Element e) { + List groups = e.getChildren("group", getNS()); + ArrayList values = new ArrayList(); + + for (int i = 0; (groups != null) && (i < groups.size()); i++) { + Element group = (Element) groups.get(i); + MediaGroup g = new MediaGroup(parseContent(group)); + + for (int j = 0; j < g.getContents().length; j++) { + if (g.getContents()[j].isDefaultContent()) { + g.setDefaultContentIndex(new Integer(j)); + + break; + } + } + + g.setMetadata(parseMetadata(group)); + values.add(g); + } + + return (MediaGroup[]) values.toArray(new MediaGroup[values.size()]); + } + + private Metadata parseMetadata(Element e) { + Metadata md = new Metadata(); + // categories + { + List categories = e.getChildren("category", getNS()); + ArrayList values = new ArrayList(); + + for (int i = 0; (categories != null) && (i < categories.size()); + i++) { + try { + Element cat = (Element) categories.get(i); + values.add(new Category(cat.getAttributeValue("scheme"), + cat.getAttributeValue("label"), cat.getText())); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing category tag.", ex); + } + } + + md.setCategories((Category[]) values.toArray( + new Category[values.size()])); + } + + // copyright + try { + Element copy = e.getChild("copyright", getNS()); + + if (copy != null) { + md.setCopyright(copy.getText()); + md.setCopyrightUrl((copy.getAttributeValue("url") != null) + ? new URI(copy.getAttributeValue("url")) : null); + } + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing copyright tag.", ex); + } + // credits + { + List credits = e.getChildren("credit", getNS()); + ArrayList values = new ArrayList(); + + for (int i = 0; (credits != null) && (i < credits.size()); i++) { + try { + Element cred = (Element) credits.get(i); + values.add(new Credit(cred.getAttributeValue("scheme"), + cred.getAttributeValue("role"), cred.getText())); + md.setCredits( (Credit[]) values.toArray( new Credit[ values.size()])); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing credit tag.", ex); + } + } + } + + // description + try { + Element description = e.getChild("description", getNS()); + + if (description != null) { + md.setDescription(description.getText()); + md.setDescriptionType(description.getAttributeValue("type")); + } + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing description tag.", ex); + } + + // hash + try { + Element hash = e.getChild("hash", getNS()); + + if (hash != null) { + md.setHash(new Hash(hash.getAttributeValue("algo"), + hash.getText())); + } + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing hash tag.", ex); + } + // keywords + { + Element keywords = e.getChild("keywords", getNS()); + + if (keywords != null) { + StringTokenizer tok = new StringTokenizer(keywords.getText(), + ","); + String[] value = new String[tok.countTokens()]; + + for (int i = 0; tok.hasMoreTokens(); i++) { + value[i] = tok.nextToken().trim(); + } + + md.setKeywords(value); + } + } + // ratings + { + List ratings = e.getChildren("rating", getNS()); + ArrayList values = new ArrayList(); + + for (int i = 0; (ratings != null) && (i < ratings.size()); i++) { + try { + Element rat = (Element) ratings.get(i); + values.add(new Rating(rat.getAttributeValue("scheme"), + rat.getText())); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing rating tag.", ex); + } + } + + md.setRatings((Rating[]) values.toArray(new Rating[values.size()])); + } + // text + { + List texts = e.getChildren("text", getNS()); + ArrayList values = new ArrayList(); + + for (int i = 0; (texts != null) && (i < texts.size()); i++) { + try { + Element text = (Element) texts.get(i); + Time start = (text.getAttributeValue("start") == null) + ? null : new Time(text.getAttributeValue("start")); + Time end = (text.getAttributeValue("end") == null) ? null + : new Time(text.getAttributeValue( + "end")); + values.add(new Text(text.getAttributeValue("type"), + text.getTextTrim(), start, end)); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing text tag.", ex); + } + } + + md.setText((Text[]) values.toArray(new Text[values.size()])); + } + // thumbnails + { + List thumbnails = e.getChildren("thumbnail", getNS()); + ArrayList values = new ArrayList(); + + for (int i = 0; (thumbnails != null) && (i < thumbnails.size()); + i++) { + try { + Element thumb = (Element) thumbnails.get(i); + Time t = (thumb.getAttributeValue("time") == null) ? null + : new Time(thumb.getAttributeValue( + "time")); + Integer width = (thumb.getAttributeValue("width") == null) + ? null : new Integer(thumb.getAttributeValue("width")); + Integer height = (thumb.getAttributeValue("height") == null) + ? null : new Integer(thumb.getAttributeValue("height")); + values.add(new Thumbnail( + new URI(thumb.getAttributeValue("url")), width, + height, t)); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing thumbnail tag.", + ex); + } + } + + md.setThumbnail((Thumbnail[]) values.toArray( + new Thumbnail[values.size()])); + } + // title + { + Element title = e.getChild("title", getNS()); + + if (title != null) { + md.setTitle(title.getText()); + md.setTitleType(title.getAttributeValue("type")); + } + } + // restrictions + { + List restrictions = e.getChildren("restriction", getNS()); + ArrayList values = new ArrayList(); + + for (int i = 0; i < restrictions.size(); i++) { + Element r = (Element) restrictions.get(i); + Restriction.Type type = null; + + if (r.getAttributeValue("type").equalsIgnoreCase("uri")) { + type = Restriction.Type.URI; + } else if (r.getAttributeValue("type").equalsIgnoreCase("country")) { + type = Restriction.Type.COUNTRY; + } + + Restriction.Relationship relationship = null; + + if (r.getAttributeValue("relationship").equalsIgnoreCase("allow")) { + relationship = Restriction.Relationship.ALLOW; + } else if (r.getAttributeValue("relationship").equalsIgnoreCase("deny")) { + relationship = Restriction.Relationship.DENY; + } + + Restriction value = new Restriction(relationship, type, + r.getTextTrim()); + values.add(value); + } + + md.setRestrictions((Restriction[]) values.toArray( + new Restriction[values.size()])); + } + // handle adult + { + Element adult = e.getChild("adult", getNS()); + + if ((adult != null) && (md.getRatings().length == 0)) { + Rating[] r = new Rating[1]; + + if (adult.getTextTrim().equals("true")) { + r[0] = new Rating("urn:simple", "adult"); + } else { + r[0] = new Rating("urn:simple", "nonadult"); + } + + md.setRatings(r); + } + } + + return md; + } + + private PlayerReference parsePlayer(Element e) { + Element player = e.getChild("player", getNS()); + PlayerReference p = null; + + if (player != null) { + Integer width = (player.getAttributeValue("width") == null) ? null + : new Integer(player.getAttributeValue( + "width")); + Integer height = (player.getAttributeValue("height") == null) + ? null : new Integer(player.getAttributeValue("height")); + + try { + p = new PlayerReference(new URI(player.getAttributeValue("url")), + width, height); + } catch (Exception ex) { + LOG.log(Level.WARNING, "Exception parsing player tag.", ex); + } + } + + return p; + } + + public Namespace getNS() { + return NS; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/io/RSS20YahooParser.java b/src/main/java/com/sun/syndication/feed/module/mediarss/io/RSS20YahooParser.java new file mode 100644 index 0000000..157c9a7 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/io/RSS20YahooParser.java @@ -0,0 +1,94 @@ +/* + * Copyright 2006 Nathanial X. Freitas, openvision.tv + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.mediarss.io; + +import com.sun.syndication.feed.WireFeed; +import com.sun.syndication.io.impl.RSS20Parser; + +import org.jdom.Document; +import org.jdom.Element; +import org.jdom.Namespace; + +import java.util.List; + + +/** + * @author Nathanial X. Freitas + * + * + */ +public class RSS20YahooParser extends RSS20Parser { + //the Yahoo Namespace URI they sometimes use in the returns for video.search.yahoo.com RSS feed + private static final String RSS_URI = "urn:yahoo:yn"; + + // + public RSS20YahooParser() { + this("rss_2.0yahoo"); + } + + protected RSS20YahooParser(String type) { + super(type); + } + + /** + * Indicates if a JDom document is an RSS instance that can be parsed with the parser. + *

+ * It checks for RDF ("http://www.w3.org/1999/02/22-rdf-syntax-ns#") and + * RSS ("http://purl.org/rss/1.0/") namespaces being defined in the root element. + * + * @param document document to check if it can be parsed with this parser implementation. + * @return true if the document is RSS1., false otherwise. + */ + public boolean isMyType(Document document) { + boolean ok = false; + + Element rssRoot = document.getRootElement(); + Namespace defaultNS = rssRoot.getNamespace(); + List additionalNSs = rssRoot.getAdditionalNamespaces(); + + ok = (defaultNS != null) && defaultNS.equals(getRSSNamespace()); + + return ok; + } + + /** + * Returns the namespace used by RSS elements in document of the RSS 1.0 + *

+ * + * @return returns "http://purl.org/rss/1.0/". + */ + protected Namespace getRSSNamespace() { + return Namespace.getNamespace(RSS_URI); + } + + /** + * After we parse the feed we put "rss_2.0" in it (so converters and generators work) + * this parser is a phantom. + * + */ + protected WireFeed parseChannel(Element rssRoot) { + WireFeed wFeed = super.parseChannel(rssRoot); + wFeed.setFeedType("rss_2.0"); + + return wFeed; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/io/package.html b/src/main/java/com/sun/syndication/feed/module/mediarss/io/package.html new file mode 100644 index 0000000..328588a --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/io/package.html @@ -0,0 +1,11 @@ + + + + + + + + This package contains parsers and generators for the module as well as a specia feed + parser for Yahoo's custom RSS2 namespace. + + diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/package.html b/src/main/java/com/sun/syndication/feed/module/mediarss/package.html new file mode 100644 index 0000000..ae93e29 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/package.html @@ -0,0 +1,54 @@ + + + + + + + + This module supports Yahoo! MediaRSS elements for ROME feeds. + + Sample usage: + 

+            SyndFeed feed =  input.build( myRSSFile );
+            List entries = feed.getEntries();
+            for( int i = 0; i < entries.size(); i++ ){
+                System.out.println( ((SyndEntry) entries.get(i)).getModule( MediaModule.URI ) );
+            }
+
+ Alternatively, to add a media item to an entry: + 
+      MediaContent[] contents = new MediaContent[1];
+      MediaContent myItem = new MediaContent( new UrlReference("http://me.com/movie.mpg") );
+      contents[0] = myItem();
+      Metadata md = new Metadata();
+      Thumbnail[] thumbs = new Thumbnail[2];
+      thumbs[0] = new Thumbnail( new URL("http://me.com/movie1.jpg") );
+      thumbs[1] = new Thumbnail( new URL("http://me.com/movie2.jpg") );
+      md.setThumbnail( thumbs );
+      myItem.setMetadata( md );
+      MediaEntryModuleImpl module = new MediaEntryModuleImpl();
+      module.setContents( contents );
+      mySyndEntry.getModules().add( module );
+      
+
+ + 
+ * This code is currently released under the Mozilla Public License.
+ * http://www.mozilla.org/MPL/
+ *
+ * Alternately you may apply the terms of the Apache Software License
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+
+ + diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/AbstractSchemeValue.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/AbstractSchemeValue.java new file mode 100644 index 0000000..075c2cc --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/AbstractSchemeValue.java @@ -0,0 +1,54 @@ +/* + * AbstractSchemeValue.java + * + * Created on April 18, 2006, 8:03 PM + * + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss.types; + +import java.io.Serializable; + + +/** Simple data bean parent for scheme-value type entities. + * + * @author cooper + */ +public abstract class AbstractSchemeValue implements Serializable { + private static final long serialVersionUID = -917128796432458636L; + private String scheme; + private String value; + + public AbstractSchemeValue(String scheme, String value) { + if ((scheme == null) || (value == null)) { + throw new NullPointerException("Scheme and value cannot be null."); + } + + this.scheme = scheme; + this.value = value; + } + + public String getScheme() { + return scheme; + } + + public String getValue() { + return value; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/Category.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Category.java new file mode 100644 index 0000000..af1b35a --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Category.java @@ -0,0 +1,122 @@ +/* + * Category.java + * + * Created on April 18, 2006, 8:04 PM + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss.types; + +import java.io.Serializable; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; + + +/** + * + * <media:category>

+ *

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.

+ * 
        <media:category scheme="http://search.yahoo.com/mrss/category_
+ *        schema">music/artist/album/song</media:category>
+ *
+ *        <media:category scheme="http://dmoz.org" label="Ace Ventura - Pet
+ *        Detective">Arts/Movies/Titles/A/Ace_Ventura_Series/Ace_Ventura_
+ *        -_Pet_Detective</media:category>
+ *
+ *        <media:category scheme="urn:flickr:tags">ycantpark
+ *        mobile</media:category>
+ * + *

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'.

+ * + *

label is the human readable label that can be displayed in end user applications. It is an optional attribute.

+ * @author cooper + */ +public class Category implements Serializable { + private static final long serialVersionUID = 5182373808661745402L; + /** + * Schem for FLICKR tags + */ + public static final String SCHEME_FLICKR_TAGS = "urn:flickr:tags"; + private String label; + private String scheme; + private String value; + + /** + * Creates a new instance of Category + * @param scheme scheme used + * @param label label for the category + * @param value value of the category item + */ + public Category(String scheme, String label, String value) { + this.scheme = scheme; + this.value = value; + this.label = label; + } + + /** + * Creates a new Category. + * @param value value of the category. + */ + public Category(String value) { + this.value = value; + } + + /** + * 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 '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; + } + + /** + * value of the category + * @return value of the category + */ + public String getValue() { + return value; + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(this.getClass(), this); + + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(this.getClass(), this); + + return equals.beanHashCode(); + } + + public String toString() { + ToStringBean tsBean = new ToStringBean(this.getClass(), this); + + return tsBean.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/Credit.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Credit.java new file mode 100644 index 0000000..bdf7914 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Credit.java @@ -0,0 +1,138 @@ +/* + * Credit.java + * + * Created on April 18, 2006, 7:34 PM + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss.types; + +import java.io.Serializable; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; + + +/** + * + * <media:credit>

+ * + *

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 <media:credit> elements. + * It has 2 optional attributes.

+ * 
        <media:credit role="producer" scheme="urn:ebu">entity name</media:credit>
+ *
+ *

role specifies the role the entity played. Must be lowercase. It is an optional attribute.

+ * + *

scheme 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.

+ * + * + *

Example roles:

+ * 
        actor
+ *        anchor person
+ *        author
+ *        choreographer
+ *        composer
+ *        conductor
+ *        director
+ *        editor
+ *        graphic designer
+ *        grip
+ *        illustrator
+ *        lyricist
+ *        music arranger
+ *        music group
+ *        musician
+ *        orchestra
+ *        performer
+ *        photographer
+ *        producer
+ *        reporter
+ *        vocalist
+ *
+ *

Additional roles: European Broadcasting Union Role Codes + * @author cooper + */ +public class Credit implements Serializable { + private static final long serialVersionUID = 7722721287224043428L; + /** + * Scheme value for the EBU credits. + */ + public static final String SCHEME_EBU = "urn:ebu"; + private String name; + private String role; + private String scheme; + + /** + * Creates a new instance of Credit + * @param scheme schem used + * @param role role name + * @param name persons name + */ + public Credit(String scheme, String role, String name) { + if (name == null) { + throw new NullPointerException("A credit name cannot be null."); + } + + this.scheme = (scheme == null) ? SCHEME_EBU : scheme; + this.role = (role == null) ? null : role.toLowerCase(); + this.name = name; + } + + /** + * Person/organizations name + * @return Person/organizations name + */ + public String getName() { + return name; + } + + /** + * Role name + * @return Role name + */ + public String getRole() { + return role; + } + + /** + * Scheme used. + * @return Scheme used. + */ + public String getScheme() { + return scheme; + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(this.getClass(), this); + + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(this.getClass(), this); + + return equals.beanHashCode(); + } + + public String toString() { + ToStringBean tsBean = new ToStringBean(this.getClass(), this); + + return tsBean.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/Expression.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Expression.java new file mode 100644 index 0000000..770ed90 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Expression.java @@ -0,0 +1,52 @@ +/* This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.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. + */ +public class Expression implements Serializable { + private static final long serialVersionUID = 2356898289547679768L; + + /** + * Represents a complete media object. + */ + public static final Expression FULL = new Expression("full"); + + /** + * Represents a sample media object. + */ + public static final Expression SAMPLE = new Expression("sample"); + + /** + * represents a streaming media object. + */ + public static final Expression NONSTOP = new Expression("nonstop"); + private String value; + + private Expression(String value) { + this.value = value; + } + + public String toString() { + return this.value; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/Hash.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Hash.java new file mode 100644 index 0000000..ddd2851 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Hash.java @@ -0,0 +1,86 @@ +/* + * Hash.java + * + * Created on April 18, 2006, 8:06 PM + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss.types; + +import java.io.Serializable; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; + + +/** + * + * <media:hash>

+ * + *

This is the hash of the binary media file. It can appear multiple times as long as each instance is a different algo. It has 1 optional attribute.

+ * + * 
        <media:hash algo="md5">dfdec888b72151965a34b4b59031290a</media:hash>
+ * + *

algo 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 + */ +public class Hash extends AbstractSchemeValue implements Serializable { + private static final long serialVersionUID = 3566980635881544337L; + + /** + * Creates a new instance of Hash + * @param algorithm algoright used + * @param value value of the hash + */ + public Hash(String algorithm, String value) { + super(algorithm == null ? "MD5": algorithm , value); + } + /** + * Creates a new instance of Hash assuming the default algorithm of MD5 + * @param algorithm algoright used + */ + public Hash(String value ){ + this( null, value); + } + + /** + * Alsorithm used for the hash + * @return Alsorithm used for the hash + */ + public String getAlgorithm() { + return super.getScheme(); + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(this.getClass(), this); + + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(this.getClass(), this); + + return equals.beanHashCode(); + } + + public String toString() { + ToStringBean tsBean = new ToStringBean(this.getClass(), this); + + return tsBean.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/MediaContent.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/MediaContent.java new file mode 100644 index 0000000..d43b8fa --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/MediaContent.java @@ -0,0 +1,458 @@ +/* + * Copyright 2006 Nathanial X. Freitas, openvision.tv + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.mediarss.types; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; + +import java.io.Serializable; + + +/** + * <media:content>

+ *

<media:content> is a sub-element of either <item> or <media:group>. Media objects that are not the same content should not be included in the same <media:group> element. 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.

+ * + * 
+ *        <media:content
+ *               url="http://www.foo.com/movie.mov"
+ *               fileSize="12216320"
+ *               type="video/quicktime"
+ *               medium="video"
+ *               isDefault="true"
+ *               expression="full"
+ *               bitrate="128"
+ *               framerate="25"
+ *               samplingrate="44.1"
+ *               channels="2"
+ *               duration="185"
+ *               height="200"
+ *               width="300"
+ *               lang="en" />
+ * + *

url should specify the direct url to the media object. If not included, a <media:player> element must be specified.

fileSize is the number of bytes of the media object. It is an optional attribute.

+ *

type is the standard MIME type of the object. It is an optional attribute.

+ * + *

medium is the type of object (image | audio | video | document | executable). While this attribute can at times seem redundant if type 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.

+ * + * + *

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.

+ * + *

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.

+ * + *

bitrate is the kilobits per second rate of media. It is an optional attribute.

+ *

framerate is the number of frames per second for the media object. 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.

+ *

channels is number of audio channels in the media object. It is an optional attribute. + *

duration is the number of seconds the media object plays. It is an optional attribute.

+ * + * + * + * + * + *

height is the height of the media object. It is an optional attribute.

+ *

width is the width of the media object. 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.

+ * + * + *

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.

+ * @author Nathanial X. Freitas + * + * MediaContent corresponds to the element defined within the MediaRSS specification. + * There may be one or more instances within each instance of an within an + * RSS 2.0 document. + */ +public class MediaContent implements Serializable { + private static final long serialVersionUID = -4990262574794352616L; + private Expression expression; + private Float bitrate = null; + private Float framerate = null; + private Float samplingrate = null; + + /*private variable for storing instances of Thumbnail class + each MediaContent can have zero to many thumbnails*/ + private Integer audioChannels = null; + + /*the height in pixels of the resource*/ + private Integer height = null; + + /*the width in pixels of the resource*/ + private Integer width = null; + + /*the duration in seconds of the resource*/ + private Long duration = null; + + /*the file size in bytes of the resouce*/ + private Long fileSize = null; + private Metadata metadata; + private PlayerReference player; + private Reference reference; + private String language; + private String medium; + + /*the MIME type of the resource*/ + private String type = null; + private boolean defaultContent; + + /* + * MediaContent constructor + */ + + /** + * Creates a new MediaContent + * @param reference UrlReference or Player reference for the item. + */ + public MediaContent(Reference reference) { + super(); + + if (reference == null) { + throw new NullPointerException("You must provide either a PlayerReference or URL reference."); + } + + this.setReference(reference); + } + + /** + * 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(Integer audioChannels) { + this.audioChannels = audioChannels; + } + + /** + * 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; + } + + /** + * bitrate is the kilobits per second rate of media. It is an optional attribute. + * @param bitrate bitrate is the kilobits per second rate of media. It is an optional attribute. + */ + public void setBitrate(Float bitrate) { + this.bitrate = bitrate; + } + + /** + * bitrate is the kilobits per second rate of media. It is an optional attribute. + * @return bitrate is the kilobits per second rate of media. It is an optional attribute. + */ + public Float getBitrate() { + return bitrate; + } + + /** + * isDefault determines if this is the default object that should be used for the . There should only be one default object per . It is an optional attribute. + * @param defaultContent isDefault determines if this is the default object that should be used for the . There should only be one default object per . It is an optional attribute. + */ + public void setDefaultContent(boolean defaultContent) { + this.defaultContent = defaultContent; + } + + /** + * isDefault determines if this is the default object that should be used for the . There should only be one default object per . It is an optional attribute. + * @return isDefault determines if this is the default object that should be used for the . There should only be one default object per . It is an optional attribute. + */ + public boolean isDefaultContent() { + return defaultContent; + } + + /** + * 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(Long duration) { + this.duration = duration; + } + + /** + * 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. + * @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(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. + * @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; + } + + /** + * + * fileSize is the number of bytes of the media object. It is an optional attribute. + * @param fileSize The fileSize to set. + */ + public void setFileSize(Long fileSize) { + this.fileSize = fileSize; + } + + /** + * fileSize is the number of bytes of the media object. It is an optional attribute. + * @return Returns the fileSize. + */ + public Long getFileSize() { + return fileSize; + } + + /** + * 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(Float framerate) { + this.framerate = framerate; + } + + /** + * 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; + } + + /** + * height is the height of the media object. It is an optional attribute. + * @param height height is the height of the media object. It is an optional attribute. + */ + public void setHeight(Integer height) { + this.height = height; + } + + /** + * height is the height of the media object. It is an optional attribute. + * @return height is the height of the media object. It is an optional attribute. + */ + public Integer getHeight() { + return height; + } + + /** + * 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(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. + * @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; + } + + /** + * Set the value of medium + * + * @param newmedium new value of medium + */ + public void setMedium(String newmedium) { + this.medium = newmedium; + } + + /** + * Get the value of medium + * + * @return the value of medium + */ + public String getMedium() { + return this.medium; + } + + /** + * The metadata for the item + * @param metadata The metadata for the item + */ + public void setMetadata(Metadata metadata) { + this.metadata = metadata; + } + + /** + * The metadata for the item + * @return The metadata for the item + */ + public Metadata getMetadata() { + return metadata; + } + + /** + * <media:player>

+ *

Allows the media object to be accessed through a web browser media player console. + * This element is required only if a direct media url attribute is not specified in the <media:content> element. It has 1 required attribute, and 2 optional attributes.

+ * 
        <media:player url="http://www.foo.com/player?id=1111" height="200" width="400" />
+ *

url is the url of the player console that plays the media. It is a required attribute.

+ * + *

height is the height of the browser window that the url should be opened in. It is an optional attribute.

+ *

width is the width of the browser window that the url should be opened in. It is an optional attribute.

+ * + *

+ * @param player PlayerReference for the item. + */ + public void setPlayer(PlayerReference player) { + this.player = player; + } + + /** + * <media:player>

+ *

Allows the media object to be accessed through a web browser media player console. + * This element is required only if a direct media url attribute is not specified in the <media:content> element. It has 1 required attribute, and 2 optional attributes.

+ * 
        <media:player url="http://www.foo.com/player?id=1111" height="200" width="400" />
+ *

url is the url of the player console that plays the media. It is a required attribute.

+ * + *

height is the height of the browser window that the url should be opened in. It is an optional attribute.

+ *

width is the width of the browser window that the url should be opened in. It is an optional attribute.

+ * @return PlayerReference for the item. + */ + public PlayerReference getPlayer() { + return player; + } + + /** + * The player or URL reference for the item + * @param reference The player or URL reference for the item + */ + public void setReference(Reference reference) { + this.reference = reference; + + if (reference instanceof PlayerReference) { + this.setPlayer((PlayerReference) reference); + } + } + + /** + * The player or URL reference for the item + * @return The player or URL reference for the item + */ + public Reference getReference() { + return reference; + } + + /** + * 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(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. + * @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; + } + + /** + * + * type is the standard MIME type of the object. It is an optional attribute. + * @param type The type to set. + */ + public void setType(String type) { + this.type = type; + } + + /** + * + * type is the standard MIME type of the object. It is an optional attribute. + * @return Returns the type. + */ + public String getType() { + return type; + } + + /** + * width is the width of the media object. It is an optional attribute. + * @param width width is the width of the media object. It is an optional attribute. + */ + public void setWidth(Integer width) { + this.width = width; + } + + /** + * width is the width of the media object. It is an optional attribute. + * @return width is the width of the media object. It is an optional attribute. + */ + public Integer getWidth() { + return width; + } + + public Object clone() { + MediaContent c = new MediaContent(getReference()); + c.setAudioChannels(getAudioChannels()); + c.setBitrate(getBitrate()); + c.setDefaultContent(isDefaultContent()); + c.setDuration(getDuration()); + c.setExpression(getExpression()); + c.setFileSize(getFileSize()); + c.setFramerate(getFramerate()); + c.setHeight(getHeight()); + c.setLanguage(getLanguage()); + c.setMetadata((getMetadata() == null) ? null : (Metadata) getMetadata() + .clone()); + c.setPlayer(getPlayer()); + c.setSamplingrate(getSamplingrate()); + c.setType(getType()); + c.setWidth(getWidth()); + + return c; + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(MediaContent.class, this); + + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(MediaContent.class, this); + + return equals.beanHashCode(); + } + + public String toString() { + ToStringBean tsBean = new ToStringBean(MediaContent.class, this); + + return tsBean.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/MediaGroup.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/MediaGroup.java new file mode 100644 index 0000000..2bbc45d --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/MediaGroup.java @@ -0,0 +1,154 @@ +/* + * MediaGroup.java + * + * Created on April 19, 2006, 12:34 AM + * + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss.types; + +import java.io.Serializable; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; + + +/** + * <media:group>

+ *

<media:group> is a sub-element of <item>. It allows grouping of <media:content> elements that are effectively the same content, yet different representations. 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.

+ * @author cooper + */ +public class MediaGroup implements Cloneable, Serializable { + private static final long serialVersionUID = 768465435081309082L; + + private Integer defaultContentIndex; + private Metadata metadata; + private MediaContent[] contents = new MediaContent[0]; + + /** + * Creates a new instance of MediaGroup + * @param contents Contents of the group. + */ + public MediaGroup(MediaContent[] contents) { + this.setContents(contents); + } + + /** + * Creates a new instance of MediaGroup + * @param contents contents of the group + * @param defaultContentIndex index of the default content value. + */ + public MediaGroup(MediaContent[] contents, Integer defaultContentIndex) { + this.setContents(contents); + this.setDefaultContentIndex(defaultContentIndex); + } + + /** + * Creates a new instance of MediaGroup + * @param contents contents of the group + * @param defaultContentIndex index of the default content item. + * @param metadata metadata for the group. + */ + public MediaGroup(MediaContent[] contents, Integer defaultContentIndex, + Metadata metadata) { + this.setContents(contents); + this.setDefaultContentIndex(defaultContentIndex); + this.setMetadata(metadata); + } + + /** + * MediaContents for the group + * @param contents MediaContents for the group + */ + public void setContents(MediaContent[] contents) { + this.contents = (contents == null) ? new MediaContent[0] : contents; + } + + /** + * MediaContents for the group + * @return MediaContents for the group + */ + public MediaContent[] getContents() { + return contents; + } + + /** + * Default content index MediaContent. + * @param defaultContentIndex Default content index MediaContent. + */ + public void setDefaultContentIndex(Integer defaultContentIndex) { + for (int i = 0; i < getContents().length; i++) { + if (i == defaultContentIndex.intValue()) { + getContents()[i].setDefaultContent(true); + } else { + getContents()[i].setDefaultContent(false); + } + } + + this.defaultContentIndex = defaultContentIndex; + } + + /** + * Default content index MediaContent. + * @return Default content index MediaContent. + */ + public Integer getDefaultContentIndex() { + return defaultContentIndex; + } + + /** + * Metadata for the group + * @param metadata Metadata for the group + */ + public void setMetadata(Metadata metadata) { + this.metadata = metadata; + } + + /** + * Metadata for the group + * @return Metadata for the group + */ + public Metadata getMetadata() { + return metadata; + } + + public Object clone() { + return new MediaGroup(getContents(), getDefaultContentIndex(), + getMetadata()); + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(this.getClass(), this); + + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(this.getClass(), this); + + return equals.beanHashCode(); + } + + public String toString() { + ToStringBean tsBean = new ToStringBean(this.getClass(), this); + + return tsBean.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/Metadata.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Metadata.java new file mode 100644 index 0000000..60dbcb5 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Metadata.java @@ -0,0 +1,620 @@ +/* + * Metadata.java + * + * Created on April 18, 2006, 7:57 PM + * + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss.types; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; + +import java.io.Serializable; +import java.net.URI; + + +/** + * + * + * + * Optional Elements + *

The following elements are optional and may appear as sub-elements of <channel>, <item>, <media:content> and/or <media:group>. + * + * + *

+ * + * When an element appears at a shallow level, such as <channel> or <item>, it means that the element should be applied to every media object within its scope.

+ * + * + *

+ * Duplicated elements appearing at deeper levels of the document tree have higher priority over other levels. + * + * For example, <media:content> level elements are favored over <item> level elements. + * The priority level is listed from strongest to weakest: <media:content>, <media:group>, <item>, <channel>.

+ * @author cooper + */ +public class Metadata implements Cloneable, Serializable { + private static final long serialVersionUID = 649350950456005250L; + + private Hash hash; + private String copyright; + private String description; + private String descriptionType; + private String title; + private String titleType; + private URI copyrightUrl; + private Category[] categories = new Category[0]; + private Credit[] credits = new Credit[0]; + private String[] keywords = new String[0]; + private Rating[] ratings = new Rating[0]; + private Restriction[] restrictions = new Restriction[0]; + private Text[] text = new Text[0]; + private Thumbnail[] thumbnail = new Thumbnail[0]; + + /** Creates a new instance of Metadata */ + public Metadata() { + super(); + } + + /** + * <media:category>

+ *

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.

+ * 
        <media:category scheme="http://search.yahoo.com/mrss/category_
+     *        schema">music/artist/album/song</media:category>
+     *
+     *        <media:category scheme="http://dmoz.org" label="Ace Ventura - Pet
+     *        Detective">Arts/Movies/Titles/A/Ace_Ventura_Series/Ace_Ventura_
+     *        -_Pet_Detective</media:category>
+     *
+     *        <media:category scheme="urn:flickr:tags">ycantpark
+     *        mobile</media:category>
+ * + *

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'.

+ * + *

label is the human readable label that can be displayed in end user applications. It is an optional attribute.

+ * @param categories categories for the item + */ + public void setCategories(Category[] categories) { + this.categories = (categories == null) ? new Category[0] : categories; + } + + /** + * <media:category>

+ *

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.

+ * 
        <media:category scheme="http://search.yahoo.com/mrss/category_
+     *        schema">music/artist/album/song</media:category>
+     *
+     *        <media:category scheme="http://dmoz.org" label="Ace Ventura - Pet
+     *        Detective">Arts/Movies/Titles/A/Ace_Ventura_Series/Ace_Ventura_
+     *        -_Pet_Detective</media:category>
+     *
+     *        <media:category scheme="urn:flickr:tags">ycantpark
+     *        mobile</media:category>
+ * + *

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'.

+ * + *

label is the human readable label that can be displayed in end user applications. It is an optional attribute.

+ * @return categories for the item. + */ + public Category[] getCategories() { + return categories; + } + + /** + * <media:copyright>

+ *

Copyright information for media object. It has 1 optional attribute.

+ * + * 
        <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
+ *

url 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.

+ * @param copyright copyright text + */ + public void setCopyright(String copyright) { + this.copyright = copyright; + } + + /** + * <media:copyright>

+ *

Copyright information for media object. It has 1 optional attribute.

+ * + * 
        <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
+ *

url 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.

+ * @return Copyright text + */ + public String getCopyright() { + return copyright; + } + + /** + * <media:copyright>

+ *

Copyright information for media object. It has 1 optional attribute.

+ * + * 
        <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
+ *

url 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.

+ * @param copyrightUrl link to more copyright information. + */ + public void setCopyrightUrl(URI copyrightUrl) { + this.copyrightUrl = copyrightUrl; + } + + /** + * <media:copyright>

+ *

Copyright information for media object. It has 1 optional attribute.

+ * + * 
        <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
+ *

url 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.

+ * @return Link to more copyright information. + */ + public URI getCopyrightUrl() { + return copyrightUrl; + } + + /** + * <media:credit>

+ * + *

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 <media:credit> elements. + * It has 2 optional attributes.

+ * 
        <media:credit role="producer" scheme="urn:ebu">entity name</media:credit>
+     *
+ *

role specifies the role the entity played. Must be lowercase. It is an optional attribute.

+ * + *

scheme 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.

+ * + * + *

Example roles:

+ * 
        actor
+     *        anchor person
+     *        author
+     *        choreographer
+     *        composer
+     *        conductor
+     *        director
+     *        editor
+     *        graphic designer
+     *        grip
+     *        illustrator
+     *        lyricist
+     *        music arranger
+     *        music group
+     *        musician
+     *        orchestra
+     *        performer
+     *        photographer
+     *        producer
+     *        reporter
+     *        vocalist
+     *
+ *

Additional roles: European Broadcasting Union Role Codes + * @param credits credits for the item. + */ + public void setCredits(Credit[] credits) { + this.credits = (credits == null) ? new Credit[0] : credits; + } + + /** + * <media:credit>

+ * + *

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 <media:credit> elements. + * It has 2 optional attributes.

+ * 
        <media:credit role="producer" scheme="urn:ebu">entity name</media:credit>
+     *
+ *

role specifies the role the entity played. Must be lowercase. It is an optional attribute.

+ * + *

scheme 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.

+ * + * + *

Example roles:

+ * 
        actor
+     *        anchor person
+     *        author
+     *        choreographer
+     *        composer
+     *        conductor
+     *        director
+     *        editor
+     *        graphic designer
+     *        grip
+     *        illustrator
+     *        lyricist
+     *        music arranger
+     *        music group
+     *        musician
+     *        orchestra
+     *        performer
+     *        photographer
+     *        producer
+     *        reporter
+     *        vocalist
+     *
+ *

Additional roles: European Broadcasting Union Role Codes + * @return credits for the time. + */ + public Credit[] getCredits() { + return credits; + } + + /** + * <media:description>

+ *

Short description describing the media object typically a sentence in length. It has 1 optional attribute.

+ * 
        <media:description type="plain">This was some really bizarre band I listened to as a young lad.</media:description>
+ *

type 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.

+ * @param description value of the description + */ + public void setDescription(String description) { + this.description = description; + } + + /** + * <media:description>

+ *

Short description describing the media object typically a sentence in length. It has 1 optional attribute.

+ * 
        <media:description type="plain">This was some really bizarre band I listened to as a young lad.</media:description>
+ *

type 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.

+ * @return value of the description + */ + public String getDescription() { + return description; + } + + /** + * <media:description>

+ *

Short description describing the media object typically a sentence in length. It has 1 optional attribute.

+ * 
        <media:description type="plain">This was some really bizarre band I listened to as a young lad.</media:description>
+ *

type 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.

+ * @param descriptionType type of the description. + */ + public void setDescriptionType(String descriptionType) { + this.descriptionType = descriptionType; + } + + /** + * <media:description>

+ *

Short description describing the media object typically a sentence in length. It has 1 optional attribute.

+ * 
        <media:description type="plain">This was some really bizarre band I listened to as a young lad.</media:description>
+ *

type 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.

+ * @return type of the description + */ + public String getDescriptionType() { + return descriptionType; + } + + /** + * <media:hash>

+ * + *

This is the hash of the binary media file. It can appear multiple times as long as each instance is a different algo. It has 1 optional attribute.

+ * + * 
        <media:hash algo="md5">dfdec888b72151965a34b4b59031290a</media:hash>
+ * + *

algo 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. + */ + public void setHash(Hash hash) { + this.hash = hash; + } + + /** + * <media:hash>

+ * + *

This is the hash of the binary media file. It can appear multiple times as long as each instance is a different algo. It has 1 optional attribute.

+ * + * 
        <media:hash algo="md5">dfdec888b72151965a34b4b59031290a</media:hash>
+ * + *

algo 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. + */ + public Hash getHash() { + return hash; + } + + /** + * <media:keywords>

+ *

Highly relevant keywords describing the media object with typically a maximum of ten words. The keywords and phrases should be comma delimited.

+ * + * 
        <media:keywords>kitty, cat, big dog, yarn, fluffy</media:keywords>
+ * @param keywords Array of keywords + */ + public void setKeywords(String[] keywords) { + this.keywords = (keywords == null) ? new String[0] : keywords; + } + + /** + * <media:keywords>

+ *

Highly relevant keywords describing the media object with typically a maximum of ten words. The keywords and phrases should be comma delimited.

+ * + * 
        <media:keywords>kitty, cat, big dog, yarn, fluffy</media:keywords>
+ * @return Array of keywords + */ + public String[] getKeywords() { + return keywords; + } + + /** + * <media:rating>

+ * + * + *

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.

+ * + * 
               <media:rating scheme="urn:simple">adult</media:rating>
+     *               <media:rating scheme="urn:icra">r (cz 1 lz 1 nz 1 oz 1 vz 1)</media:rating>
+     *               <media:rating scheme="urn:mpaa">pg</media:rating>
+     *
+     *               <media:rating scheme="urn:v-chip">tv-y7-fv</media:rating>
+ * + * + *

scheme 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).

+ * + *

+ * @param ratings Ratings objects + */ + public void setRatings(Rating[] ratings) { + this.ratings = (ratings == null) ? new Rating[0] : ratings; + } + + /** + * <media:rating>

+ * + * + *

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.

+ * + * 
               <media:rating scheme="urn:simple">adult</media:rating>
+     *               <media:rating scheme="urn:icra">r (cz 1 lz 1 nz 1 oz 1 vz 1)</media:rating>
+     *               <media:rating scheme="urn:mpaa">pg</media:rating>
+     *
+     *               <media:rating scheme="urn:v-chip">tv-y7-fv</media:rating>
+ * + * + *

scheme 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).

+ * + *

+ * @return Ratings objects + */ + public Rating[] getRatings() { + return ratings; + } + + /** + * <media:restriction>

+ * + *

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 <media:restriction> element of the same type can be applied to a media object - all others will be ignored. 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).

+ * + * 
        <media:restriction relationship="allow" type="country">au us</media:restriction>
+ * + *

relationship 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.

+ * @param restrictions restrictions for the item. + */ + public void setRestrictions(Restriction[] restrictions) { + this.restrictions = (restrictions == null) ? new Restriction[0] + : restrictions; + } + + /** + * <media:restriction>

+ * + *

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 <media:restriction> element of the same type can be applied to a media object - all others will be ignored. 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).

+ * + * 
        <media:restriction relationship="allow" type="country">au us</media:restriction>
+ * + *

relationship 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.

+ * @return restrictions for the item. + */ + public Restriction[] getRestrictions() { + return restrictions; + } + + /** + * <media:text>

+ *

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 start time. Elements can have overlapping start and end times. It has 4 optional attributes.

        <media:text type="plain" lang="en" start="00:00:03.000"
+     *        end="00:00:10.000"> Oh, say, can you see</media:text>
+     *
+     *        <media:text type="plain" lang="en" start="00:00:10.000"
+     *        end="00:00:17.000">By the dawn's early light</media:text>
+     *
+ *

type 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.

+ * + * + * + * + * + * + *

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.

+ * + *

start 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 <media:thumbnail>). It is an optional attribute.

+ * + *

end specifies the end time that the text is relevant. + * If this attribute is not provided, and a start time is used, it is expected that the end time is either the end of the clip or the start of the next <media:text> element. + * @param text text objects for the item. + */ + public void setText(Text[] text) { + this.text = (text == null) ? new Text[0] : text; + } + + /** + * <media:text>

+ *

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 start time. Elements can have overlapping start and end times. It has 4 optional attributes.

        <media:text type="plain" lang="en" start="00:00:03.000"
+     *        end="00:00:10.000"> Oh, say, can you see</media:text>
+     *
+     *        <media:text type="plain" lang="en" start="00:00:10.000"
+     *        end="00:00:17.000">By the dawn's early light</media:text>
+     *
+ *

type 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.

+ * + * + * + * + * + * + *

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.

+ * + *

start 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 <media:thumbnail>). It is an optional attribute.

+ * + *

end specifies the end time that the text is relevant. + * If this attribute is not provided, and a start time is used, it is expected that the end time is either the end of the clip or the start of the next <media:text> element. + * @return Text objects for the item. + */ + public Text[] getText() { + return text; + } + + /** + * <media:thumbnail>

+ * + * + *

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.

+ * + * + * + * + * + * 
        <media:thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123" />
+ *

url specifies the url of the thumbnail. It is a required attribute.

height specifies the height of the thumbnail. It is an optional attribute.

+ *

width specifies the width of the thumbnail. It is an optional attribute.

+ * + * + *

time + * 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 [RFC 2326 3.6 Normal Play Time]. It is an optional attribute.

+ * @param thumbnail thumbnails for the image + */ + public void setThumbnail(Thumbnail[] thumbnail) { + this.thumbnail = (thumbnail == null) ? new Thumbnail[0] : thumbnail; + } + + /** + * <media:thumbnail>

+ * + * + *

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.

+ * + * + * + * + * + * 
        <media:thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123" />
+ *

url specifies the url of the thumbnail. It is a required attribute.

height specifies the height of the thumbnail. It is an optional attribute.

+ *

width specifies the width of the thumbnail. It is an optional attribute.

+ * + * + *

time + * 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 [RFC 2326 3.6 Normal Play Time]. It is an optional attribute.

+ * @return Thumbnails for the image + */ + public Thumbnail[] getThumbnail() { + return thumbnail; + } + + /** + * <media:title>

+ *

The title of the particular media object. It has 1 optional attribute.

+ * 
        <media:title type="plain">The Judy's - The Moo Song</media:title>
+ * + *

type 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.

+ * @param title Value of the title + */ + public void setTitle(String title) { + this.title = title; + } + + /** + * <media:title>

+ *

The title of the particular media object. It has 1 optional attribute.

+ * 
        <media:title type="plain">The Judy's - The Moo Song</media:title>
+ * + *

type 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.

+ * @return value of the title. + */ + public String getTitle() { + return title; + } + + /** + * <media:title>

+ *

The title of the particular media object. It has 1 optional attribute.

+ * 
        <media:title type="plain">The Judy's - The Moo Song</media:title>
+ * + *

type 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.

+ * @param titleType type of the title. + */ + public void setTitleType(String titleType) { + this.titleType = titleType; + } + + /** + * <media:title>

+ *

The title of the particular media object. It has 1 optional attribute.

+ * 
        <media:title type="plain">The Judy's - The Moo Song</media:title>
+ * + *

type 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.

+ * @return type of the title + */ + public String getTitleType() { + return titleType; + } + + /** + * <media:copyright>

+ *

Copyright information for media object. It has 1 optional attribute.

+ * + * 
        <media:copyright url="http://blah.com/additional-info.html">2005 FooBar Media</media:copyright>
+ *

url 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.

+ * @return Link to more copyright information. + */ + public Object clone() { + Metadata md = new Metadata(); + md.setCategories(getCategories()); + md.setCopyright(getCopyright()); + md.setCopyrightUrl(getCopyrightUrl()); + md.setCredits(getCredits()); + md.setDescription(getDescription()); + md.setDescriptionType(getDescriptionType()); + md.setHash(getHash()); + md.setKeywords(getKeywords()); + md.setRatings(getRatings()); + md.setText(getText()); + md.setThumbnail(getThumbnail()); + md.setTitle(getTitle()); + md.setTitleType(getTitleType()); + md.setRestrictions(getRestrictions()); + + return md; + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(Metadata.class, this); + + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(Metadata.class, this); + + return equals.beanHashCode(); + } + + public String toString() { + ToStringBean tsBean = new ToStringBean(Metadata.class, this); + + return tsBean.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/PlayerReference.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/PlayerReference.java new file mode 100644 index 0000000..0a4e35c --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/PlayerReference.java @@ -0,0 +1,118 @@ +/* + * PlayerReference.java + * + * Created on April 18, 2006, 7:18 PM + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss.types; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; + +import java.io.Serializable; +import java.net.URI; + + +/** + * + * <media:player>

+ *

Allows the media object to be accessed through a web browser media player console. + * This element is required only if a direct media url attribute is not specified in the <media:content> element. It has 1 required attribute, and 2 optional attributes.

+ * 
        <media:player url="http://www.foo.com/player?id=1111" height="200" width="400" />
+ *

url is the url of the player console that plays the media. It is a required attribute.

+ * + *

height is the height of the browser window that the url should be opened in. It is an optional attribute.

+ *

width is the width of the browser window that the url should be opened in. It is an optional attribute.

+ * @author cooper + */ +public class PlayerReference implements Reference, Serializable { + private static final long serialVersionUID = -2618211012392630834L; + + private Integer height; + private Integer width; + private URI url; + + /** + * Creates a new instance of PlayerReference + * @param url url of the player + * @param width width of the player + * @param height height of the player + */ + public PlayerReference(URI url, Integer width, Integer height) { + super(); + + if (url == null) { + throw new NullPointerException("url cannot be null."); + } + + this.url = url; + this.height = height; + this.width = width; + } + + /** + * Constructs a new PlayerReference + * @param url URL of the player + */ + public PlayerReference(URI url) { + this(url, null, null); + } + + /** + * Height of the player + * @return Height of the player + */ + public Integer getHeight() { + return height; + } + + /** + * URL of the player + * @return URL of the player + */ + public URI getUrl() { + return url; + } + + /** + * Width of the player + * @return Width of the player + */ + public Integer getWidth() { + return width; + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(this.getClass(), this); + + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(this.getClass(), this); + + return equals.beanHashCode(); + } + + public String toString() { + ToStringBean tsBean = new ToStringBean(this.getClass(), this); + + return tsBean.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/Rating.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Rating.java new file mode 100644 index 0000000..236d5af --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Rating.java @@ -0,0 +1,99 @@ +/* + * Rating.java + * + * Created on April 18, 2006, 7:58 PM + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss.types; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; + + +/** + * <media:rating>

+ * + * + *

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.

+ * + * 
               <media:rating scheme="urn:simple">adult</media:rating>
+ *               <media:rating scheme="urn:icra">r (cz 1 lz 1 nz 1 oz 1 vz 1)</media:rating>
+ *               <media:rating scheme="urn:mpaa">pg</media:rating>
+ *
+ *               <media:rating scheme="urn:v-chip">tv-y7-fv</media:rating>
+ * + * + *

scheme 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).

+ * + * For compatibility, a medai:adult tag will appear in the ratings as a urn:simple equiv. + * @author cooper + */ +public class Rating extends AbstractSchemeValue { + private static final long serialVersionUID = 429385772347911315L; + + /** + * urn:simple adult. This will be populated on the deprecated media:adult tag as well, + */ + public static final Rating ADULT = new Rating("urn:simple", "adult"); + + /** + * urn:simple nonadult. This will be populated on the deprecated media:adult tag as well, + */ + public static final Rating NONADULT = new Rating("urn:simple", "nonadult"); + + /** + * Constructs a new Rating object. + * @param scheme scheme used for the rating + * @param value value of the rating. + */ + public Rating(String scheme, String value) { + super(scheme, value); + } + + /** + * + * @param obj + * @return + */ + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(this.getClass(), this); + + return eBean.beanEquals(obj); + } + + /** + * + * @return + */ + public int hashCode() { + EqualsBean equals = new EqualsBean(this.getClass(), this); + + return equals.beanHashCode(); + } + + /** + * + * @return + */ + public String toString() { + ToStringBean tsBean = new ToStringBean(this.getClass(), this); + + return tsBean.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/Reference.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Reference.java new file mode 100644 index 0000000..2cfc909 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Reference.java @@ -0,0 +1,32 @@ +/* + * Reference.java + * + * Created on April 18, 2006, 7:18 PM + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss.types; + + +/** This class is an idenfier for UrlReference and PlayerReference and + * is required for constructing a MediaContent object. + * + * @author cooper + */ +public interface Reference { +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/Restriction.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Restriction.java new file mode 100644 index 0000000..510ec27 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Restriction.java @@ -0,0 +1,158 @@ +/* + * Restriction.java + * + * Created on April 19, 2006, 12:17 AM + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss.types; + +import java.io.Serializable; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; + + +/** + * <media:restriction>

+ * + *

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 <media:restriction> element of the same type can be applied to a media object - all others will be ignored. 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).

+ * + * 
        <media:restriction relationship="allow" type="country">au us</media:restriction>
+ * + *

relationship 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.

+ * + *

Note: 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.

+ *

A more explicit method would be:

+ * + * 
        <media:restriction relationship="allow" type="country">au us</media:restriction>
+ * + *

type 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".

+ * + *

"country" allows restrictions to be placed based on country code. [ISO 3166]

+ *

"uri" allows restrictions based on URI. Examples: urn:apple, http://images.google.com, urn:yahoo, etc. + * @author cooper + */ +public class Restriction implements Serializable { + private static final long serialVersionUID = 7944281267467298628L; + + private Relationship relationship; + private String value; + private Type type; + + /** + * Creates a new instance of Restriction + * @param relationship a Restriction.Relationship object + * @param type A Restriction.Type object + * @param value a value for the restriction. + */ + public Restriction(Relationship relationship, Type type, String value) { + if ((value == null) || (relationship == null)) { + throw new NullPointerException( + "Value and Relationship cannot be null."); + } + + if ((type == null) && !(value.equals("all") || value.equals("none"))) { + throw new NullPointerException( + "Type is required if the value is other than 'all' or 'none'."); + } + + this.relationship = relationship; + this.type = type; + this.value = value; + } + + public Relationship getRelationship() { + return relationship; + } + + public Type getType() { + return type; + } + + public String getValue() { + return value; + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(this.getClass(), this); + + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(this.getClass(), this); + + return equals.beanHashCode(); + } + + public String toString() { + ToStringBean tsBean = new ToStringBean(this.getClass(), this); + + return tsBean.toString(); + } + + /** + * Indicates the action of the relationship + */ + public static class Relationship { + /** + * An Allow relationship + */ + public static final Relationship ALLOW = new Relationship("allow"); + + /** + * A deny relationship. + */ + public static final Relationship DENY = new Relationship("deny"); + private String value; + + private Relationship(String value) { + this.value = value; + } + + public String toString() { + return this.value; + } + } + + /** + * Indicated the type of the relationship + */ + public static class Type { + /** + * Indicates a Country type. + */ + public static final Type COUNTRY = new Type("country"); + + /** + * Indicates a URI for a special restriction type. + */ + public static final Type URI = new Type("uri"); + private String value; + + private Type(String value) { + this.value = value; + } + + public String toString() { + return this.value; + } + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/Text.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Text.java new file mode 100644 index 0000000..bcb7017 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Text.java @@ -0,0 +1,142 @@ +/* + * Text.java + * + * Created on April 18, 2006, 10:25 PM + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss.types; + +import java.io.Serializable; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; + + +/** + * <media:text>

+ *

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 start time. Elements can have overlapping start and end times. It has 4 optional attributes.

        <media:text type="plain" lang="en" start="00:00:03.000"
+ *        end="00:00:10.000"> Oh, say, can you see</media:text>
+ *
+ *        <media:text type="plain" lang="en" start="00:00:10.000"
+ *        end="00:00:17.000">By the dawn's early light</media:text>
+ *
+ *

type 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.

+ * + * + * + * + * + * + *

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.

+ * + *

start 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 <media:thumbnail>). It is an optional attribute.

+ * + *

end specifies the end time that the text is relevant. + * If this attribute is not provided, and a start time is used, it is expected that the end time is either the end of the clip or the start of the next <media:text> element.

+ * @author cooper + */ +public class Text implements Serializable { + private static final long serialVersionUID = 9043514380583850045L; + private String type; + private String value; + private Time end; + private Time start; + + /** + * Creates a text object. + * @param value value of the text + */ + public Text(String value) { + this.value = value; + } + + /** + * Creates a new instance of Text + * @param type type of text + * @param value value of text + */ + public Text(String type, String value) { + this.type = type; + this.value = value; + } + + /** + * Creates a text object with start and end times + * @param type type of text + * @param value value of text + * @param start start time + * @param end end time + */ + public Text(String type, String value, Time start, Time end) { + this(type, value); + this.start = start; + this.end = end; + } + + /** + * End time of the text + * @return End time of the text + */ + public Time getEnd() { + return end; + } + + /** + * Start time of the text + * @return Start time of the text + */ + public Time getStart() { + return start; + } + + /** + * type of the text + * @return type of the text + */ + public String getType() { + return this.type; + } + + /** + * Value of the text + * @return type of the text + */ + public String getValue() { + return this.value; + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(this.getClass(), this); + + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(this.getClass(), this); + + return equals.beanHashCode(); + } + + public String toString() { + ToStringBean tsBean = new ToStringBean(this.getClass(), this); + + return tsBean.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/Thumbnail.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Thumbnail.java new file mode 100644 index 0000000..f5dda72 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Thumbnail.java @@ -0,0 +1,145 @@ +/* + * Copyright 2006 Nathanial X. Freitas, openvision.tv + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ +package com.sun.syndication.feed.module.mediarss.types; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; + +import java.io.Serializable; +import java.net.URI; + + +/** + * <media:thumbnail>

+ * + * + *

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.

+ * + * + * + * + * + * 
        <media:thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123" />
+ *

url specifies the url of the thumbnail. It is a required attribute.

height specifies the height of the thumbnail. It is an optional attribute.

+ *

width specifies the width of the thumbnail. It is an optional attribute.

+ * + * + *

time + * 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 [RFC 2326 3.6 Normal Play Time]. It is an optional attribute.

+ */ +public class Thumbnail implements Cloneable, Serializable { + private static final long serialVersionUID = 2035345549055202026L; + + private Integer thumbHeight = null; + private Integer thumbWidth = null; + private Time time; + private URI thumbUrl = null; + + /** + * Creates a new thumbnail + * @param url URL to thumbnail + * @param width width in pixels + * @param height height in pixels + * @param time Timecode representing the thumbnails position in a source. + */ + public Thumbnail(URI url, Integer width, Integer height, Time time) { + this.thumbUrl = url; + this.thumbHeight = height; + this.thumbWidth = width; + this.time = time; + } + + /** + * Creates a new thumbnail + * @param url URL + * @param width width + * @param height height + */ + public Thumbnail(URI url, Integer width, Integer height) { + this(url, width, height, null); + } + + /** + * Creates a new thumbnail + * @param url URL + */ + public Thumbnail(URI url) { + this(url, null, null, null); + } + + /** + * + * Returns the thumbHeight. + * @return Returns the thumbHeight. + */ + public Integer getHeight() { + return thumbHeight; + } + + /** + * returns the time that the thumbnail was captured from its source + * @return returns the time that the thumbnail was captured from its source + */ + public Time getTime() { + return time; + } + + /** + * + * Retursn the URL + * @return Returns the thumbUrl. + */ + public URI getUrl() { + return thumbUrl; + } + + /** + * + * Returns width. + * @return Returns the thumbWidth. + */ + public Integer getWidth() { + return thumbWidth; + } + + public Object clone() { + return new Thumbnail(this.thumbUrl, this.thumbWidth, this.thumbHeight); + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(this.getClass(), this); + + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(this.getClass(), this); + + return equals.beanHashCode(); + } + + public String toString() { + ToStringBean tsBean = new ToStringBean(this.getClass(), this); + + return tsBean.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/Time.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Time.java new file mode 100644 index 0000000..0468af6 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/Time.java @@ -0,0 +1,106 @@ +/* + * Time.java + * + * Created on April 18, 2006, 9:48 PM + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss.types; + +import com.sun.syndication.feed.impl.EqualsBean; +import com.sun.syndication.feed.impl.ToStringBean; + +import java.io.Serializable; +import java.text.NumberFormat; + + +/** + * Represents a RFC 2326 3.6 Normal Play Time timestamp. + * @author cooper + */ +public class Time implements Serializable { + private static final long serialVersionUID = 4088522049885593073L; + + private static final long SECOND = 1000; + private static final long MINUTE = 60 * SECOND; + private static final long HOUR = 60 * MINUTE * SECOND; + private static final NumberFormat nf = NumberFormat.getInstance(); + + static { + nf.setMinimumIntegerDigits(2); + } + + private long milliseconds = 0; + + /** + * Creates a new instance of Time + * @param milliseconds milliseconds in length or offset. + */ + public Time(long milliseconds) { + this.milliseconds = milliseconds; + } + + /** + * Creates a new instance of Time + * @param value RFC 2326 3.6 Normal Play Time value + */ + public Time(String value) { + String[] values = value.split(":"); + int count = values.length - 1; + this.milliseconds = (long) (Double.parseDouble(values[count]) * (double) SECOND); + count--; + + if (count >= 0) { + milliseconds += (Long.parseLong(values[count]) * MINUTE); + count--; + } + + if (count >= 0) { + milliseconds += (Long.parseLong(values[count]) * HOUR); + } + } + + public long getValue() { + return milliseconds; + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(this.getClass(), this); + + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(this.getClass(), this); + + return equals.beanHashCode(); + } + + public String toString() { + long value = this.milliseconds; + long hours = value / HOUR; + value -= (hours * HOUR); + + long minutes = value / MINUTE; + value -= (minutes * MINUTE); + + double seconds = (double) value / (double) SECOND; + + return nf.format(hours) + ":" + nf.format(minutes) + ":" + seconds; + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/UrlReference.java b/src/main/java/com/sun/syndication/feed/module/mediarss/types/UrlReference.java new file mode 100644 index 0000000..3924460 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/UrlReference.java @@ -0,0 +1,92 @@ +/* + * UrlReference.java + * + * Created on April 18, 2006, 7:18 PM + * + * + * This code is currently released under the Mozilla Public License. + * http://www.mozilla.org/MPL/ + * + * Alternately you may apply the terms of the Apache Software License + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.sun.syndication.feed.module.mediarss.types; + +import com.sun.syndication.feed.impl.EqualsBean; + +import java.io.Serializable; +import java.net.URI; +import java.net.URISyntaxException; + + +/** + * Used to indicate a URL primary reference for a MediaContent object. + * @author cooper + */ +public class UrlReference implements Reference, Serializable { + private static final long serialVersionUID = -178149736468242989L; + + private URI url; + + /** + * Creates a new UrlReference. + * @param url URL to the media source + */ + public UrlReference(URI url) { + if (url == null) { + throw new NullPointerException("url cannot be null."); + } + + this.url = url; + } + + /** + * Creates a new instance of UrlReference + * @param url String value of a URL + * @throws java.net.MalformedURLException thrown on bad URLs + */ + public UrlReference(String url) throws URISyntaxException { + super(); + + if (url == null) { + throw new NullPointerException("url cannot be null."); + } + + this.url = new URI(url); + } + + /** + * Returns the URL value + * @return Returns the URL value + */ + public URI getUrl() { + return this.url; + } + + public boolean equals(Object obj) { + EqualsBean eBean = new EqualsBean(this.getClass(), this); + + return eBean.beanEquals(obj); + } + + public int hashCode() { + EqualsBean equals = new EqualsBean(this.getClass(), this); + + return equals.beanHashCode(); + } + + public String toString() { + return url.toString(); + } +} diff --git a/src/main/java/com/sun/syndication/feed/module/mediarss/types/package.html b/src/main/java/com/sun/syndication/feed/module/mediarss/types/package.html new file mode 100644 index 0000000..3ac4ff7 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/mediarss/types/package.html @@ -0,0 +1,10 @@ + + + + + + + + This package contains datatypes for working with MediaRSS. + + diff --git a/src/main/java/com/sun/syndication/feed/module/opensearch/OpenSearchModule.java b/src/main/java/com/sun/syndication/feed/module/opensearch/OpenSearchModule.java new file mode 100644 index 0000000..0ba6195 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/opensearch/OpenSearchModule.java @@ -0,0 +1,27 @@ +/* + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package com.sun.syndication.feed.module.opensearch; + +import com.sun.syndication.feed.module.Module; + +/** Provides access to A9 Open Search information. + * @author Michael W. Nassif (enrouteinc@gmail.com) + */ +public interface OpenSearchModule extends Module, OpenSearchResponse{ + + public final static String URI = "http://a9.com/-/spec/opensearch/1.1/"; + +} diff --git a/src/main/java/com/sun/syndication/feed/module/opensearch/OpenSearchResponse.java b/src/main/java/com/sun/syndication/feed/module/opensearch/OpenSearchResponse.java new file mode 100644 index 0000000..1c33160 --- /dev/null +++ b/src/main/java/com/sun/syndication/feed/module/opensearch/OpenSearchResponse.java @@ -0,0 +1,139 @@ +/* + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package com.sun.syndication.feed.module.opensearch; + +import java.util.List; + +import com.sun.syndication.feed.atom.Link; +import com.sun.syndication.feed.module.opensearch.entity.OSQuery; + +/** Provides access to A9 Open Search information. + * @author Michael W. Nassif (enrouteinc@gmail.com) + */ +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. + * @param totalResults A positive integer value. + */ + public void setTotalResults(int totalResults); + + /** + * # 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. + * @return a positive integer value. + */ + public int getTotalResults(); + + /** + * # 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. + * @param startIndex int value >= 1. + */ + public void setStartIndex(int startIndex); + + /** + * # 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. + * @return int value >= 1. + */ + public int getStartIndex(); + + /** + * # 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. + * @param itemsPerPage int value >= 1. + */ + public void setItemsPerPage(int itemsPerPage); + + /** + * # 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. + * @return int value >= 1 + */ + public int getItemsPerPage(); + + /** + * # 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. + * @param link link to the open search spec. + */ + public void setLink(Link link); + + /** + * # 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. + * @return link to the opensearch spec. + */ + public Link getLink(); + + // list of OSResponseQuery interfaces + /** + * Query – in an OpenSearch Response, can be used both to echo back the original query and to suggest new searches. + * Please see the OpenSearch Query specification for more information. + *