christophedelory.playlist.wpl
Class Fragment

java.lang.Object
  christophedelory.playlist.wpl.Fragment

public class Fragment
extends Object

Specifies one condition of the query that selects items from the library. Conditions are specified by condition strings. A condition string typically has a name portion, a condition portion, and a value portion.
Certain condition strings have a metadata attribute portion, a condition portion, and a value portion. For example, in the condition string "Album Artist Is Joe", the metadata attribute portion is "Album Artist", the condition portion is "Is", and the value portion is "Joe".
Example:

 <fragment name = "Album Artist">
  <argument name = "condition">Is</argument>
  <argument name = "value">Joe</argument>
 </fragment>
 

For condition strings of this type, the following table shows the possible metadata attributes, possible conditions and possible values:

Metadata attribute	Possible conditions	Possible values
Actor, Album Artist, Album Title, Author, Caption, Channel, Composer, Conductor, Content Provider, Content Provider Genre, Contributing Artist, Copyright Text, Director, Episode, File Type, Genre, Key, Keywords, Language, Mood, Parental Rating, Period, Producer, Provider, Publisher, Series, Station name, Subgenre, Subtitle, Title, Writer	Equals, Does Not Equal, Is, Is Not, Contains, Does Not Contain	Any string value
Bit Rate (in kilobytes per second)	Equals, Does Not Equal, Is, Is Not, Contains, Does Not Contain	48, 64, 96, 128, 160, 192, 256, 300, 500, 750, 1000, 1500, 3000, 4500, 6000, 7500
Secondary Media Type	Equals, Does Not Equal, Is, Is Not, Contains, Does Not Contain	Audio: News, Audio: Talk Show, Audio: Audio Books, Audio: Audio Spoken Word, Video: News, Video: Talk Show, Video: Home Video, Video: Movie / Film, Video: TV show, Video: Corporate Video, Video: Music Video
File Size (in KB), Image height, Image width, Play Count : Afternoon Totals, Play Count : Evening Totals, Play Count : Morning Totals, Play Count : Night Totals, Play Count : Total Overall, Play Count : Total Weekday, Play Count : Total Weekend	Is Less Than, Is Greater Than, Is, Is Not	Any number
Broadcast time, Date Encoded, Date Recorded, Date taken, Release Year	Is Before, Is After, Is, Is Not	Yesterday, Last week, Last month, 6 months, 1 year, 2 years, 5 years, 2000s, 1990s, 1980s, 1970s, 1960s, 1950s, 1940s
Date Added	Is Before, Is After, Is, Is Not	Yesterday, Last week, Last month, 6 months, 1 year, 2 years, 5 years
Date Last Played	Older Than, More Recent Than, Is, Is Not	Yesterday, Last week, Last month, 6 months, 1 year, 2 years, 5 years
Month taken	Is Before, Is More Recent Than, Is, Is Not	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
Year taken	Is Before, Is More Recent Than, Is, Is Not	Any year
Auto Rating, My Rating	Is At Least, Is No More Than, Is, Is Not	Unrated, 1 Star, 2 Stars, 3 Stars, 4 Stars, 5 Stars
Custom Field #1, Custom Field #2, File Name, Key Fields	Contains, Does Not Contain	Any string

Certain condition strings have a limiter portion, a number portion and a format portion. For example in the condition string "Limit Total Size To 3 Megabytes", the limiter portion is "Limit Total Size To", the number portion is "3" and the format portion is "Megabytes".
Example:

 <fragment name = "Limit Total Size To">
  <argument name = "number">3</argument>
  <argument name = "format">Megabytes</argument>
 </fragment>
 

For condition strings of this type the following table shows the possible limiters and formats:

Limiter	Possible numbers	Possible formats
Limit Total Size To	Any number	Kilobytes, Megabytes, Gigabytes
Limit Total Duration To	Any number	Seconds, Minutes, Hours, Days

Certain condition strings have a limiter portion and a number portion. For example in the condition string "Limit Number of Items to 25", the limiter portion is "Limit Number of Items" and the number portion is "25".
Example:

 <fragment name = "Limit Number of Items">
  <argument name = "number">25</argument>
 </fragment>
 

For condition strings of this type the following table shows the only possible limiter:

Limiter	Possible numbers
Limit Number Of Items	Any number

Certain condition strings have a protection portion and a condition portion. For example in the condition string "Protection Is present", the protection portion is "Protection" and the condition portion is "Is".
Example:

 <fragment name = "Protection">
  <argument name = "condition">Is</argument>
 </fragment>
 

For condition strings of this type the following table shows the possible conditions:

Protection portion	Possible conditions
Protection	Is, Is Not

There is one type of fragment element that does not contain a condition string. If the name attribute of a fragment element is "Randomize Playback Order" the fragment element contains no argument elements. This fragment element instructs the player to play the list in random order.
Example:

 <fragment name = "Randomize Playback Order">
 </fragment>
 

Certain condition strings have a sort portion, a value portion and a condition portion. For example, in the condition string "Sort By Title Ascending order", the sort portion is "Sort By", the value portion is "Title", and the condition portion is "Ascending". Note that in this case the value portion is a metadata attribute.
Example:

 <fragment name = "Sort By">
  <argument name = "value">Title</argument>
  <argument name = "condition">Ascending</argument>
 </fragment>
 

For condition strings of this type the following table shows the possible values and conditions:

Sort portion	Possible values	Possible conditions
Sort By	Genre, Title, Date Added, Auto Rating, My Rating, Play Count : Total Overall, Play Count : Morning Totals, Play Count : Afternoon Totals, Play Count : Evening Totals, Play Count : Night Totals, Play Count : Total Weekday, Play Count : Total Weekend, Actor, Subtitle, Station name, Channel, Broadcast time, Director, Release Year, Writer, Producer, Date Recorded, Date Encoded, Bit Rate, Protection	Ascending, Descending, Random

When you use a fragment element to sort a playlist, you must sort on a metadata attribute that applies to the type of media items you are sorting. For example, if you are sorting music items you can not sort on Actor. The following table shows which metadata attributes you can use to sort which media types:

Media type	Possible metadata attributes
Music	Genre, Title, Date Added, Auto Rating, My Rating, Play Count : Total Overall, Play Count : Morning Totals, Play Count :Afternoon Totals, Play Count :Evening Totals, Play Count :Night Totals, Play Count :Total Weekday, Play Count : Total Weekend
Video or TV	Genre, Actor, Subtitle, Title, Date Added, Auto Rating, Station name, Channel, Broadcast time, Director, Release Year, Writer, Producer, Date Recorded, Date Encoded, Bit Rate, My Rating, Protection, Play Count : Total Overall, Play Count : Morning Totals, Play Count : Afternoon Totals, Play Count : Evening Totals, Play Count : Night Totals, Play Count : Total Weekday, Play Count : Total Weekend
Radio	Title, Date Added, Bit Rate
Photo	Title
Other	Genre, Title, Date Added, Auto Rating, My Rating, Bit Rate, Play Count : Total Overall, Play Count : Morning Totals, Play Count : Afternoon Totals, Play Count : Evening Totals, Play Count : Night Totals, Play Count : Total Weekday, Play Count : Total Weekend

Windows Media Player 9 Series or later.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Fragment()

Method Summary

void	addArgument(Argument argument) Adds an argument element to this fragment.
List<Argument>	getArguments() Returns the list of argument elements.
String	getName() Returns a portion of a condition string.
void	setName(String name) Initializes a portion of a condition string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Fragment

public Fragment()

Method Detail

addArgument

public void addArgument(Argument argument)

Adds an argument element to this fragment.

Parameters:

argument - an argument element. Shall not be null.

Throws:

NullPointerException - if argument is null.

See Also:

getArguments()

getArguments

public List<Argument> getArguments()

Returns the list of argument elements.

Returns:

a list of argument elements. May be empty but not null.

See Also:

addArgument(christophedelory.playlist.wpl.Argument)

getName

public String getName()

Returns a portion of a condition string.

Returns:

a fragment name. Shall not be null.

See Also:

setName(java.lang.String)

setName

public void setName(String name)

Initializes a portion of a condition string.

Parameters:

name - a fragment name. Shall not be null.

Throws:

NullPointerException - if name is null.

See Also:

getName()