Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

yarfraw.generated.mrss.elements
Class MrssExtension

java.lang.Object
  extended by yarfraw.generated.mrss.elements.MrssExtension

public class MrssExtension
extends Object

Java class for anonymous complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{http://tools.search.yahoo.com/mrss/}group" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://tools.search.yahoo.com/mrss/}content" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://tools.search.yahoo.com/mrss/}rating" minOccurs="0"/>
         <element ref="{http://tools.search.yahoo.com/mrss/}title" minOccurs="0"/>
         <element ref="{http://tools.search.yahoo.com/mrss/}description" minOccurs="0"/>
         <element ref="{http://tools.search.yahoo.com/mrss/}keywords" minOccurs="0"/>
         <element ref="{http://tools.search.yahoo.com/mrss/}thumbnail" minOccurs="0"/>
         <element ref="{http://tools.search.yahoo.com/mrss/}category" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://tools.search.yahoo.com/mrss/}hash" minOccurs="0"/>
         <element ref="{http://tools.search.yahoo.com/mrss/}player" minOccurs="0"/>
         <element ref="{http://tools.search.yahoo.com/mrss/}credit" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://tools.search.yahoo.com/mrss/}restriction" minOccurs="0"/>
         <element ref="{http://tools.search.yahoo.com/mrss/}copyright" minOccurs="0"/>
         <element ref="{http://tools.search.yahoo.com/mrss/}text" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary
protected  List<MrssCategoryType> category
           
protected  List<MrssContentType> content
           
protected  MrssCopyrightType copyright
           
protected  List<MrssCreditType> credit
           
protected  MrssDescriptionType description
           
protected  List<MrssGroupType> group
           
protected  MrssHashType hash
           
protected  String keywords
           
protected  MrssPlayerType player
           
protected  MrssRatingType rating
           
protected  MrssRestrictionType restriction
           
protected  MrssTextType text
           
protected  MrssThumbnailType thumbnail
           
protected  MrssTitleType title
           
 
Constructor Summary
MrssExtension()
           
 
Method Summary
 List<MrssCategoryType> getCategory()
          <media:category>
 List<MrssContentType> getContent()
          <media:content>
 MrssCopyrightType getCopyright()
          <media:copyright>
 List<MrssCreditType> getCredit()
          <media:credit>
 MrssDescriptionType getDescription()
          <media:description>
 List<MrssGroupType> getGroup()
          <media:group>
 MrssHashType getHash()
          <media:hash>
 String getKeywords()
          <media:keywords>
 MrssPlayerType getPlayer()
          <media:player>
 MrssRatingType getRating()
          This allows the permissible audience to be declared.
 MrssRestrictionType getRestriction()
          <media:restriction>
 MrssTextType getText()
          <media:text>
 MrssThumbnailType getThumbnail()
          <media:thumbnail>
 MrssTitleType getTitle()
          <media:title>
 void setCopyright(MrssCopyrightType value)
          Sets the value of the copyright property.
 void setDescription(MrssDescriptionType value)
          Sets the value of the description property.
 void setHash(MrssHashType value)
          Sets the value of the hash property.
 void setKeywords(String value)
          Sets the value of the keywords property.
 void setPlayer(MrssPlayerType value)
          Sets the value of the player property.
 void setRating(MrssRatingType value)
          Sets the value of the rating property.
 void setRestriction(MrssRestrictionType value)
          Sets the value of the restriction property.
 void setText(MrssTextType value)
          Sets the value of the text property.
 void setThumbnail(MrssThumbnailType value)
          Sets the value of the thumbnail property.
 void setTitle(MrssTitleType value)
          Sets the value of the title property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

group

protected List<MrssGroupType> group

content

protected List<MrssContentType> content

rating

protected MrssRatingType rating

title

protected MrssTitleType title

description

protected MrssDescriptionType description

keywords

protected String keywords

thumbnail

protected MrssThumbnailType thumbnail

category

protected List<MrssCategoryType> category

hash

protected MrssHashType hash

player

protected MrssPlayerType player

credit

protected List<MrssCreditType> credit

restriction

protected MrssRestrictionType restriction

copyright

protected MrssCopyrightType copyright

text

protected MrssTextType text
Constructor Detail

MrssExtension

public MrssExtension()
Method Detail

getGroup

public List<MrssGroupType> getGroup()
<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.

Gets the value of the group property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the group property.

For example, to add a new item, do as follows: 

    getGroup().add(newItem);

Objects of the following type(s) are allowed in the list MrssGroupType

getContent

public List<MrssContentType> getContent()
<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.

Note: While both <media:content> and <media:group> have no limitations on the number of times they can appear, the general nature of RSS should be preserved: an <item> represents a "story". Simply stated, this is similar to the blog style of syndication. However, if one is using this module to strictly publish media, there should be one <item> element for each media object/group. This is to allow for proper attribution for the origination of the media content through the <link> element. It also allows the full benefit of the other RSS elements to be realized.

Gets the value of the content property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the content property.

For example, to add a new item, do as follows: 

    getContent().add(newItem);

Objects of the following type(s) are allowed in the list MrssContentType

getRating

public MrssRatingType getRating()

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

Returns:
possible object is MrssRatingType

setRating

public void setRating(MrssRatingType value)
Sets the value of the rating property.

Parameters:
value - allowed object is MrssRatingType

getTitle

public MrssTitleType getTitle()
<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.

Returns:
possible object is MrssTitleType

setTitle

public void setTitle(MrssTitleType value)
Sets the value of the title property.

Parameters:
value - allowed object is MrssTitleType

getDescription

public MrssDescriptionType getDescription()
<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.

Returns:
possible object is MrssDescriptionType

setDescription

public void setDescription(MrssDescriptionType value)
Sets the value of the description property.

Parameters:
value - allowed object is MrssDescriptionType

getKeywords

public String getKeywords()
<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>

Returns:
possible object is String

setKeywords

public void setKeywords(String value)
Sets the value of the keywords property.

Parameters:
value - allowed object is String

getThumbnail

public MrssThumbnailType getThumbnail()
<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.

Notes:

NTP has a second or subsecond resolution. It is specified as H:M:S.h (npt-hhmmss) or S.h (npt-sec), where H=hours, M=minutes, S=second and h=fractions of a second.

A possible alternative to NTP would be SMPTE. It is believed that NTP is simpler and easier to use.

Returns:
possible object is MrssThumbnailType

setThumbnail

public void setThumbnail(MrssThumbnailType value)
Sets the value of the thumbnail property.

Parameters:
value - allowed object is MrssThumbnailType

getCategory

public List<MrssCategoryType> getCategory()
<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.

Gets the value of the category property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the category property.

For example, to add a new item, do as follows: 

    getCategory().add(newItem);

Objects of the following type(s) are allowed in the list MrssCategoryType

getHash

public MrssHashType getHash()
<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.

Returns:
possible object is MrssHashType

setHash

public void setHash(MrssHashType value)
Sets the value of the hash property.

Parameters:
value - allowed object is MrssHashType

getPlayer

public MrssPlayerType getPlayer()
<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.

Returns:
possible object is MrssPlayerType

setPlayer

public void setPlayer(MrssPlayerType value)
Sets the value of the player property.

Parameters:
value - allowed object is MrssPlayerType

getCredit

public List<MrssCreditType> getCredit()
<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 Gets the value of the credit property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the credit property.

For example, to add a new item, do as follows: 

    getCredit().add(newItem);

Objects of the following type(s) are allowed in the list MrssCreditType

getRestriction

public MrssRestrictionType getRestriction()
<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.

Returns:
possible object is MrssRestrictionType

setRestriction

public void setRestriction(MrssRestrictionType value)
Sets the value of the restriction property.

Parameters:
value - allowed object is MrssRestrictionType

getCopyright

public MrssCopyrightType getCopyright()
<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.

Returns:
possible object is MrssCopyrightType

setCopyright

public void setCopyright(MrssCopyrightType value)
Sets the value of the copyright property.

Parameters:
value - allowed object is MrssCopyrightType

getText

public MrssTextType getText()
<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.

Returns:
possible object is MrssTextType

setText

public void setText(MrssTextType value)
Sets the value of the text property.

Parameters:
value - allowed object is MrssTextType
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2008. All Rights Reserved.