PlaylistModel.java

Go to the documentation of this file.

/*
 *      Copyright (C) 2005-2013 Team XBMC
 *      http://xbmc.org
 *
 *  This Program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 *  This Program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with XBMC Remote; see the file license.  If not, write to
 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 *  http://www.gnu.org/copyleft/gpl.html
 *
 */
package org.xbmc.android.jsonrpc.api.model;

import android.os.Parcel;
import android.os.Parcelable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.codehaus.jackson.JsonNode;
import org.codehaus.jackson.node.ArrayNode;
import org.codehaus.jackson.node.ObjectNode;
import org.xbmc.android.jsonrpc.api.AbstractModel;

public final class PlaylistModel {

        public static class Item extends AbstractModel {
                public final static String API_TYPE = "Playlist.Item";

                // class members
                public final Albumid albumid;
                public final Artistid artistid;
                public final Episodeid episodeid;
                public final File file;
                public final Genreid genreid;
                public final Movieid movieid;
                public final Musicvideoid musicvideoid;
                public final RecursiveDirectoryMedia recursiveDirectoryMedia;
                public final Songid songid;

                public Item(Albumid albumid) {
                        this.albumid = albumid;
                        this.artistid = null;
                        this.episodeid = null;
                        this.file = null;
                        this.genreid = null;
                        this.movieid = null;
                        this.musicvideoid = null;
                        this.recursiveDirectoryMedia = null;
                        this.songid = null;
                }

                public Item(Artistid artistid) {
                        this.artistid = artistid;
                        this.albumid = null;
                        this.episodeid = null;
                        this.file = null;
                        this.genreid = null;
                        this.movieid = null;
                        this.musicvideoid = null;
                        this.recursiveDirectoryMedia = null;
                        this.songid = null;
                }

                public Item(Episodeid episodeid) {
                        this.episodeid = episodeid;
                        this.albumid = null;
                        this.artistid = null;
                        this.file = null;
                        this.genreid = null;
                        this.movieid = null;
                        this.musicvideoid = null;
                        this.recursiveDirectoryMedia = null;
                        this.songid = null;
                }

                public Item(File file) {
                        this.file = file;
                        this.albumid = null;
                        this.artistid = null;
                        this.episodeid = null;
                        this.genreid = null;
                        this.movieid = null;
                        this.musicvideoid = null;
                        this.recursiveDirectoryMedia = null;
                        this.songid = null;
                }

                public Item(Genreid genreid) {
                        this.genreid = genreid;
                        this.albumid = null;
                        this.artistid = null;
                        this.episodeid = null;
                        this.file = null;
                        this.movieid = null;
                        this.musicvideoid = null;
                        this.recursiveDirectoryMedia = null;
                        this.songid = null;
                }

                public Item(Movieid movieid) {
                        this.movieid = movieid;
                        this.albumid = null;
                        this.artistid = null;
                        this.episodeid = null;
                        this.file = null;
                        this.genreid = null;
                        this.musicvideoid = null;
                        this.recursiveDirectoryMedia = null;
                        this.songid = null;
                }

                public Item(Musicvideoid musicvideoid) {
                        this.musicvideoid = musicvideoid;
                        this.albumid = null;
                        this.artistid = null;
                        this.episodeid = null;
                        this.file = null;
                        this.genreid = null;
                        this.movieid = null;
                        this.recursiveDirectoryMedia = null;
                        this.songid = null;
                }

                public Item(RecursiveDirectoryMedia recursiveDirectoryMedia) {
                        this.recursiveDirectoryMedia = recursiveDirectoryMedia;
                        this.albumid = null;
                        this.artistid = null;
                        this.episodeid = null;
                        this.file = null;
                        this.genreid = null;
                        this.movieid = null;
                        this.musicvideoid = null;
                        this.songid = null;
                }

                public Item(Songid songid) {
                        this.songid = songid;
                        this.albumid = null;
                        this.artistid = null;
                        this.episodeid = null;
                        this.file = null;
                        this.genreid = null;
                        this.movieid = null;
                        this.musicvideoid = null;
                        this.recursiveDirectoryMedia = null;
                }

                @Override
                public JsonNode toJsonNode() {
                        if (albumid != null) {
                                return albumid.toJsonNode();
                        }
                        if (artistid != null) {
                                return artistid.toJsonNode();
                        }
                        if (episodeid != null) {
                                return episodeid.toJsonNode();
                        }
                        if (file != null) {
                                return file.toJsonNode();
                        }
                        if (genreid != null) {
                                return genreid.toJsonNode();
                        }
                        if (movieid != null) {
                                return movieid.toJsonNode();
                        }
                        if (musicvideoid != null) {
                                return musicvideoid.toJsonNode();
                        }
                        if (recursiveDirectoryMedia != null) {
                                return recursiveDirectoryMedia.toJsonNode();
                        }
                        if (songid != null) {
                                return songid.toJsonNode();
                        }
                        return null; // this is completely excluded. theoretically.
                }

                @Override
                public void writeToParcel(Parcel parcel, int flags) {
                        parcel.writeValue(albumid);
                        parcel.writeValue(artistid);
                        parcel.writeValue(episodeid);
                        parcel.writeValue(file);
                        parcel.writeValue(genreid);
                        parcel.writeValue(movieid);
                        parcel.writeValue(musicvideoid);
                        parcel.writeValue(recursiveDirectoryMedia);
                        parcel.writeValue(songid);
                }

                protected Item(Parcel parcel) {
                        albumid = parcel.<Albumid>readParcelable(Albumid.class.getClassLoader());
                        artistid = parcel.<Artistid>readParcelable(Artistid.class.getClassLoader());
                        episodeid = parcel.<Episodeid>readParcelable(Episodeid.class.getClassLoader());
                        file = parcel.<File>readParcelable(File.class.getClassLoader());
                        genreid = parcel.<Genreid>readParcelable(Genreid.class.getClassLoader());
                        movieid = parcel.<Movieid>readParcelable(Movieid.class.getClassLoader());
                        musicvideoid = parcel.<Musicvideoid>readParcelable(Musicvideoid.class.getClassLoader());
                        recursiveDirectoryMedia = parcel.<RecursiveDirectoryMedia>readParcelable(RecursiveDirectoryMedia.class.getClassLoader());
                        songid = parcel.<Songid>readParcelable(Songid.class.getClassLoader());
                }

                public static final Parcelable.Creator<Item> CREATOR = new Parcelable.Creator<Item>() {
                        @Override
                        public Item createFromParcel(Parcel parcel) {
                                return new Item(parcel);
                        }
                        @Override
                        public Item[] newArray(int n) {
                                return new Item[n];
                        }
                };

                @Override
                public int describeContents() {
                        return 0;
                }

                public static class File extends AbstractModel {

                        // field names
                        public static final String FILE = "file";

                        // class members
                        public final String file;

                        public File(String file) {
                                this.file = file;
                        }

                        @Override
                        public JsonNode toJsonNode() {
                                final ObjectNode node = OM.createObjectNode();
                                node.put(FILE, file);
                                return node;
                        }

                        @Override
                        public void writeToParcel(Parcel parcel, int flags) {
                                parcel.writeValue(file);
                        }

                        protected File(Parcel parcel) {
                                file = parcel.readString();
                        }

                        public static final Parcelable.Creator<File> CREATOR = new Parcelable.Creator<File>() {
                                @Override
                                public File createFromParcel(Parcel parcel) {
                                        return new File(parcel);
                                }
                                @Override
                                public File[] newArray(int n) {
                                        return new File[n];
                                }
                        };

                        @Override
                        public int describeContents() {
                                return 0;
                        }
                }

                public static class RecursiveDirectoryMedia extends AbstractModel {

                        // field names
                        public static final String DIRECTORY = "directory";
                        public static final String MEDIA = "media";
                        public static final String RECURSIVE = "recursive";

                        // class members
                        public final String directory;
                        public final String media;
                        public final Boolean recursive;

                        public RecursiveDirectoryMedia(String directory, String media, Boolean recursive) {
                                this.directory = directory;
                                this.media = media;
                                this.recursive = recursive;
                        }

                        @Override
                        public JsonNode toJsonNode() {
                                final ObjectNode node = OM.createObjectNode();
                                node.put(DIRECTORY, directory);
                                node.put(MEDIA, media); // enum
                                node.put(RECURSIVE, recursive);
                                return node;
                        }

                        @Override
                        public void writeToParcel(Parcel parcel, int flags) {
                                parcel.writeValue(directory);
                                parcel.writeValue(media); // enum
                                parcel.writeInt(recursive ? 1 : 0);
                        }

                        protected RecursiveDirectoryMedia(Parcel parcel) {
                                directory = parcel.readString();
                                media = parcel.readString(); // enum
                                recursive = parcel.readInt() == 1;
                        }

                        public static final Parcelable.Creator<RecursiveDirectoryMedia> CREATOR = new Parcelable.Creator<RecursiveDirectoryMedia>() {
                                @Override
                                public RecursiveDirectoryMedia createFromParcel(Parcel parcel) {
                                        return new RecursiveDirectoryMedia(parcel);
                                }
                                @Override
                                public RecursiveDirectoryMedia[] newArray(int n) {
                                        return new RecursiveDirectoryMedia[n];
                                }
                        };

                        @Override
                        public int describeContents() {
                                return 0;
                        }

                        public interface Media {

                                public final String VIDEO = "video";
                                public final String MUSIC = "music";
                                public final String PICTURES = "pictures";
                                public final String FILES = "files";
                                public final String PROGRAMS = "programs";

                                public final static Set<String> values = new HashSet<String>(Arrays.asList(VIDEO, MUSIC, PICTURES, FILES, PROGRAMS));
                        }
                }

                public static class Movieid extends AbstractModel {

                        // field names
                        public static final String MOVIEID = "movieid";

                        // class members
                        public final Integer movieid;

                        public Movieid(Integer movieid) {
                                this.movieid = movieid;
                        }

                        @Override
                        public JsonNode toJsonNode() {
                                final ObjectNode node = OM.createObjectNode();
                                node.put(MOVIEID, movieid);
                                return node;
                        }

                        @Override
                        public void writeToParcel(Parcel parcel, int flags) {
                                parcel.writeValue(movieid);
                        }

                        protected Movieid(Parcel parcel) {
                                movieid = parcel.readInt();
                        }

                        public static final Parcelable.Creator<Movieid> CREATOR = new Parcelable.Creator<Movieid>() {
                                @Override
                                public Movieid createFromParcel(Parcel parcel) {
                                        return new Movieid(parcel);
                                }
                                @Override
                                public Movieid[] newArray(int n) {
                                        return new Movieid[n];
                                }
                        };

                        @Override
                        public int describeContents() {
                                return 0;
                        }
                }

                public static class Episodeid extends AbstractModel {

                        // field names
                        public static final String EPISODEID = "episodeid";

                        // class members
                        public final Integer episodeid;

                        public Episodeid(Integer episodeid) {
                                this.episodeid = episodeid;
                        }

                        @Override
                        public JsonNode toJsonNode() {
                                final ObjectNode node = OM.createObjectNode();
                                node.put(EPISODEID, episodeid);
                                return node;
                        }

                        @Override
                        public void writeToParcel(Parcel parcel, int flags) {
                                parcel.writeValue(episodeid);
                        }

                        protected Episodeid(Parcel parcel) {
                                episodeid = parcel.readInt();
                        }

                        public static final Parcelable.Creator<Episodeid> CREATOR = new Parcelable.Creator<Episodeid>() {
                                @Override
                                public Episodeid createFromParcel(Parcel parcel) {
                                        return new Episodeid(parcel);
                                }
                                @Override
                                public Episodeid[] newArray(int n) {
                                        return new Episodeid[n];
                                }
                        };

                        @Override
                        public int describeContents() {
                                return 0;
                        }
                }

                public static class Musicvideoid extends AbstractModel {

                        // field names
                        public static final String MUSICVIDEOID = "musicvideoid";

                        // class members
                        public final Integer musicvideoid;

                        public Musicvideoid(Integer musicvideoid) {
                                this.musicvideoid = musicvideoid;
                        }

                        @Override
                        public JsonNode toJsonNode() {
                                final ObjectNode node = OM.createObjectNode();
                                node.put(MUSICVIDEOID, musicvideoid);
                                return node;
                        }

                        @Override
                        public void writeToParcel(Parcel parcel, int flags) {
                                parcel.writeValue(musicvideoid);
                        }

                        protected Musicvideoid(Parcel parcel) {
                                musicvideoid = parcel.readInt();
                        }

                        public static final Parcelable.Creator<Musicvideoid> CREATOR = new Parcelable.Creator<Musicvideoid>() {
                                @Override
                                public Musicvideoid createFromParcel(Parcel parcel) {
                                        return new Musicvideoid(parcel);
                                }
                                @Override
                                public Musicvideoid[] newArray(int n) {
                                        return new Musicvideoid[n];
                                }
                        };

                        @Override
                        public int describeContents() {
                                return 0;
                        }
                }

                public static class Artistid extends AbstractModel {

                        // field names
                        public static final String ARTISTID = "artistid";

                        // class members
                        public final Integer artistid;

                        public Artistid(Integer artistid) {
                                this.artistid = artistid;
                        }

                        @Override
                        public JsonNode toJsonNode() {
                                final ObjectNode node = OM.createObjectNode();
                                node.put(ARTISTID, artistid);
                                return node;
                        }

                        @Override
                        public void writeToParcel(Parcel parcel, int flags) {
                                parcel.writeValue(artistid);
                        }

                        protected Artistid(Parcel parcel) {
                                artistid = parcel.readInt();
                        }

                        public static final Parcelable.Creator<Artistid> CREATOR = new Parcelable.Creator<Artistid>() {
                                @Override
                                public Artistid createFromParcel(Parcel parcel) {
                                        return new Artistid(parcel);
                                }
                                @Override
                                public Artistid[] newArray(int n) {
                                        return new Artistid[n];
                                }
                        };

                        @Override
                        public int describeContents() {
                                return 0;
                        }
                }

                public static class Albumid extends AbstractModel {

                        // field names
                        public static final String ALBUMID = "albumid";

                        // class members
                        public final Integer albumid;

                        public Albumid(Integer albumid) {
                                this.albumid = albumid;
                        }

                        @Override
                        public JsonNode toJsonNode() {
                                final ObjectNode node = OM.createObjectNode();
                                node.put(ALBUMID, albumid);
                                return node;
                        }

                        @Override
                        public void writeToParcel(Parcel parcel, int flags) {
                                parcel.writeValue(albumid);
                        }

                        protected Albumid(Parcel parcel) {
                                albumid = parcel.readInt();
                        }

                        public static final Parcelable.Creator<Albumid> CREATOR = new Parcelable.Creator<Albumid>() {
                                @Override
                                public Albumid createFromParcel(Parcel parcel) {
                                        return new Albumid(parcel);
                                }
                                @Override
                                public Albumid[] newArray(int n) {
                                        return new Albumid[n];
                                }
                        };

                        @Override
                        public int describeContents() {
                                return 0;
                        }
                }

                public static class Songid extends AbstractModel {

                        // field names
                        public static final String SONGID = "songid";

                        // class members
                        public final Integer songid;

                        public Songid(Integer songid) {
                                this.songid = songid;
                        }

                        @Override
                        public JsonNode toJsonNode() {
                                final ObjectNode node = OM.createObjectNode();
                                node.put(SONGID, songid);
                                return node;
                        }

                        @Override
                        public void writeToParcel(Parcel parcel, int flags) {
                                parcel.writeValue(songid);
                        }

                        protected Songid(Parcel parcel) {
                                songid = parcel.readInt();
                        }

                        public static final Parcelable.Creator<Songid> CREATOR = new Parcelable.Creator<Songid>() {
                                @Override
                                public Songid createFromParcel(Parcel parcel) {
                                        return new Songid(parcel);
                                }
                                @Override
                                public Songid[] newArray(int n) {
                                        return new Songid[n];
                                }
                        };

                        @Override
                        public int describeContents() {
                                return 0;
                        }
                }

                public static class Genreid extends AbstractModel {

                        // field names
                        public static final String GENREID = "genreid";

                        // class members
                        public final Integer genreid;

                        public Genreid(Integer genreid) {
                                this.genreid = genreid;
                        }

                        @Override
                        public JsonNode toJsonNode() {
                                final ObjectNode node = OM.createObjectNode();
                                node.put(GENREID, genreid);
                                return node;
                        }

                        @Override
                        public void writeToParcel(Parcel parcel, int flags) {
                                parcel.writeValue(genreid);
                        }

                        protected Genreid(Parcel parcel) {
                                genreid = parcel.readInt();
                        }

                        public static final Parcelable.Creator<Genreid> CREATOR = new Parcelable.Creator<Genreid>() {
                                @Override
                                public Genreid createFromParcel(Parcel parcel) {
                                        return new Genreid(parcel);
                                }
                                @Override
                                public Genreid[] newArray(int n) {
                                        return new Genreid[n];
                                }
                        };

                        @Override
                        public int describeContents() {
                                return 0;
                        }
                }
        }

        public static class PropertyValue extends AbstractModel {
                public final static String API_TYPE = "Playlist.Property.Value";

                // field names
                public static final String SIZE = "size";
                public static final String TYPE = "type";

                // class members
                public final Integer size;
                public final String type;

                public PropertyValue(Integer size, String type) {
                        this.size = size;
                        this.type = type;
                }

                public PropertyValue(JsonNode node) {
                        size = parseInt(node, SIZE);
                        type = parseString(node, TYPE);
                }

                @Override
                public JsonNode toJsonNode() {
                        final ObjectNode node = OM.createObjectNode();
                        node.put(SIZE, size);
                        node.put(TYPE, type); // enum
                        return node;
                }

                static List<PropertyValue> getPlaylistModelPropertyValueList(JsonNode node, String key) {
                        if (node.has(key)) {
                                final ArrayNode a = (ArrayNode)node.get(key);
                                final List<PropertyValue> l = new ArrayList<PropertyValue>(a.size());
                                for (int i = 0; i < a.size(); i++) {
                                        l.add(new PropertyValue((JsonNode)a.get(i)));
                                }
                                return l;
                        }
                        return new ArrayList<PropertyValue>(0);
                }

                @Override
                public void writeToParcel(Parcel parcel, int flags) {
                        parcel.writeValue(size);
                        parcel.writeValue(type); // enum
                }

                protected PropertyValue(Parcel parcel) {
                        size = parcel.readInt();
                        type = parcel.readString(); // enum
                }

                public static final Parcelable.Creator<PropertyValue> CREATOR = new Parcelable.Creator<PropertyValue>() {
                        @Override
                        public PropertyValue createFromParcel(Parcel parcel) {
                                return new PropertyValue(parcel);
                        }
                        @Override
                        public PropertyValue[] newArray(int n) {
                                return new PropertyValue[n];
                        }
                };

                @Override
                public int describeContents() {
                        return 0;
                }

                public interface Type {

                        public final String UNKNOWN = "unknown";
                        public final String VIDEO = "video";
                        public final String AUDIO = "audio";
                        public final String PICTURE = "picture";
                        public final String MIXED = "mixed";

                        public final static Set<String> values = new HashSet<String>(Arrays.asList(UNKNOWN, VIDEO, AUDIO, PICTURE, MIXED));
                }
        }

        public interface PropertyName {

                public final String TYPE = "type";
                public final String SIZE = "size";

                public final static Set<String> values = new HashSet<String>(Arrays.asList(TYPE, SIZE));
        }

        public interface Type {

                public final String UNKNOWN = "unknown";
                public final String VIDEO = "video";
                public final String AUDIO = "audio";
                public final String PICTURE = "picture";
                public final String MIXED = "mixed";

                public final static Set<String> values = new HashSet<String>(Arrays.asList(UNKNOWN, VIDEO, AUDIO, PICTURE, MIXED));
        }
}