Coverage Report - org.jaudiotagger.tag.id3.ID3v24FieldKey
 
Classes in this File Line Coverage Branch Coverage Complexity
ID3v24FieldKey
98%
66/67
N/A
1
 
 1  
 package org.jaudiotagger.tag.id3;
 2  
 
 3  
 import org.jaudiotagger.tag.id3.framebody.FrameBodyTXXX;
 4  
 import org.jaudiotagger.tag.id3.framebody.FrameBodyUFID;
 5  
 import org.jaudiotagger.tag.id3.framebody.FrameBodyWXXX;
 6  
 
 7  
 /**
 8  
  * List of known id3v24 metadata fields
 9  
  * <p/>
 10  
  * <p>These provide a mapping from the generic key to the underlying ID3v24frames. For example most of the Musicbrainz
 11  
  * fields are implemented using a User Defined Text Info Frame, but with a different description key, so this
 12  
  * enum provides the link between the two.
 13  
  */
 14  4
 public enum ID3v24FieldKey
 15  
 {
 16  4
     ARTIST(ID3v24Frames.FRAME_ID_ARTIST, Id3FieldType.TEXT),
 17  4
     ALBUM(ID3v24Frames.FRAME_ID_ALBUM, Id3FieldType.TEXT),
 18  4
     TITLE(ID3v24Frames.FRAME_ID_TITLE, Id3FieldType.TEXT),
 19  4
     TRACK(ID3v24Frames.FRAME_ID_TRACK, Id3FieldType.TEXT),
 20  4
     YEAR(ID3v24Frames.FRAME_ID_YEAR, Id3FieldType.TEXT),
 21  4
     GENRE(ID3v24Frames.FRAME_ID_GENRE, Id3FieldType.TEXT),
 22  4
     COMMENT(ID3v24Frames.FRAME_ID_COMMENT, Id3FieldType.TEXT),
 23  4
     ALBUM_ARTIST(ID3v24Frames.FRAME_ID_ACCOMPANIMENT, Id3FieldType.TEXT),
 24  4
     COMPOSER(ID3v24Frames.FRAME_ID_COMPOSER, Id3FieldType.TEXT),
 25  4
     GROUPING(ID3v24Frames.FRAME_ID_CONTENT_GROUP_DESC, Id3FieldType.TEXT),
 26  4
     DISC_NO(ID3v24Frames.FRAME_ID_SET, Id3FieldType.TEXT),
 27  4
     BPM(ID3v24Frames.FRAME_ID_BPM, Id3FieldType.TEXT),
 28  4
     ENCODER(ID3v24Frames.FRAME_ID_ENCODEDBY, Id3FieldType.TEXT),
 29  4
     MUSICBRAINZ_ARTISTID(ID3v24Frames.FRAME_ID_USER_DEFINED_INFO, FrameBodyTXXX.MUSIC_BRAINZ_ARTISTID, Id3FieldType.TEXT),
 30  4
     MUSICBRAINZ_RELEASEID(ID3v24Frames.FRAME_ID_USER_DEFINED_INFO, FrameBodyTXXX.MUSIC_BRAINZ_ALBUMID, Id3FieldType.TEXT),
 31  4
     MUSICBRAINZ_RELEASEARTISTID(ID3v24Frames.FRAME_ID_USER_DEFINED_INFO, FrameBodyTXXX.MUSIC_BRAINZ_ALBUM_ARTISTID, Id3FieldType.TEXT),
 32  4
     MUSICBRAINZ_TRACK_ID(ID3v24Frames.FRAME_ID_UNIQUE_FILE_ID, FrameBodyUFID.UFID_MUSICBRAINZ, Id3FieldType.TEXT),
 33  4
     MUSICBRAINZ_DISC_ID(ID3v24Frames.FRAME_ID_USER_DEFINED_INFO, FrameBodyTXXX.MUSIC_BRAINZ_DISCID, Id3FieldType.TEXT),
 34  4
     MUSICIP_ID(ID3v24Frames.FRAME_ID_USER_DEFINED_INFO, FrameBodyTXXX.MUSICIP_ID, Id3FieldType.TEXT),
 35  4
     AMAZON_ID(ID3v24Frames.FRAME_ID_USER_DEFINED_INFO, FrameBodyTXXX.AMAZON_ASIN, Id3FieldType.TEXT),
 36  4
     MUSICBRAINZ_RELEASE_STATUS(ID3v24Frames.FRAME_ID_USER_DEFINED_INFO, FrameBodyTXXX.MUSICBRAINZ_ALBUM_STATUS, Id3FieldType.TEXT),
 37  4
     MUSICBRAINZ_RELEASE_TYPE(ID3v24Frames.FRAME_ID_USER_DEFINED_INFO, FrameBodyTXXX.MUSICBRAINZ_ALBUM_TYPE, Id3FieldType.TEXT),
 38  4
     MUSICBRAINZ_RELEASE_COUNTRY(ID3v24Frames.FRAME_ID_USER_DEFINED_INFO, FrameBodyTXXX.MUSICBRAINZ_ALBUM_COUNTRY, Id3FieldType.TEXT),
 39  4
     LYRICS(ID3v24Frames.FRAME_ID_UNSYNC_LYRICS, Id3FieldType.TEXT),
 40  4
     IS_COMPILATION(ID3v24Frames.FRAME_ID_IS_COMPILATION, Id3FieldType.TEXT),
 41  4
     ARTIST_SORT(ID3v24Frames.FRAME_ID_ARTIST_SORT_ORDER, Id3FieldType.TEXT),
 42  4
     ALBUM_ARTIST_SORT(ID3v24Frames.FRAME_ID_ALBUM_ARTIST_SORT_ORDER_ITUNES, Id3FieldType.TEXT),
 43  4
     ALBUM_SORT(ID3v24Frames.FRAME_ID_ALBUM_SORT_ORDER, Id3FieldType.TEXT),
 44  4
     TITLE_SORT(ID3v24Frames.FRAME_ID_TITLE_SORT_ORDER, Id3FieldType.TEXT),
 45  4
     COMPOSER_SORT(ID3v24Frames.FRAME_ID_COMPOSER_SORT_ORDER_ITUNES, Id3FieldType.TEXT),
 46  4
     COVER_ART(ID3v24Frames.FRAME_ID_ATTACHED_PICTURE, Id3FieldType.BINARY),
 47  4
     ISRC(ID3v24Frames.FRAME_ID_ISRC, Id3FieldType.TEXT),
 48  4
     BARCODE(ID3v24Frames.FRAME_ID_USER_DEFINED_INFO, FrameBodyTXXX.BARCODE, Id3FieldType.TEXT),
 49  4
     CATALO_NO(ID3v24Frames.FRAME_ID_USER_DEFINED_INFO, FrameBodyTXXX.CATALOG_NO, Id3FieldType.TEXT),
 50  4
     RECORD_LABEL(ID3v24Frames.FRAME_ID_PUBLISHER, Id3FieldType.TEXT),
 51  4
     LYRICIST(ID3v24Frames.FRAME_ID_LYRICIST, Id3FieldType.TEXT),
 52  4
     CONDUCTOR(ID3v24Frames.FRAME_ID_CONDUCTOR, Id3FieldType.TEXT),
 53  4
     REMIXER(ID3v24Frames.FRAME_ID_REMIXED, Id3FieldType.TEXT),
 54  4
     MOOD(ID3v24Frames.FRAME_ID_MOOD, Id3FieldType.TEXT),
 55  4
     MEDIA(ID3v24Frames.FRAME_ID_MEDIA_TYPE, Id3FieldType.TEXT),
 56  4
     URL_OFFICIAL_RELEASE_SITE(ID3v24Frames.FRAME_ID_USER_DEFINED_URL, FrameBodyWXXX.URL_OFFICIAL_RELEASE_SITE, Id3FieldType.TEXT),
 57  4
     URL_DISCOGS_RELEASE_SITE(ID3v24Frames.FRAME_ID_USER_DEFINED_URL, FrameBodyWXXX.URL_DISCOGS_RELEASE_SITE, Id3FieldType.TEXT),
 58  4
     URL_WIKIPEDIA_RELEASE_SITE(ID3v24Frames.FRAME_ID_USER_DEFINED_URL, FrameBodyWXXX.URL_WIKIPEDIA_RELEASE_SITE, Id3FieldType.TEXT),
 59  4
     URL_OFFICIAL_ARTIST_SITE(ID3v24Frames.FRAME_ID_URL_ARTIST_WEB, Id3FieldType.TEXT),
 60  4
     URL_DISCOGS_ARTIST_SITE(ID3v24Frames.FRAME_ID_USER_DEFINED_URL, FrameBodyWXXX.URL_DISCOGS_ARTIST_SITE, Id3FieldType.TEXT),
 61  4
     URL_WIKIPEDIA_ARTIST_SITE(ID3v24Frames.FRAME_ID_USER_DEFINED_URL, FrameBodyWXXX.URL_WIKIPEDIA_ARTIST_SITE, Id3FieldType.TEXT),
 62  4
     LANGUAGE(ID3v24Frames.FRAME_ID_LANGUAGE,Id3FieldType.TEXT),
 63  4
     KEY(ID3v24Frames.FRAME_ID_INITIAL_KEY,Id3FieldType.TEXT),
 64  4
     URL_LYRICS_SITE(ID3v24Frames.FRAME_ID_USER_DEFINED_URL, FrameBodyWXXX.URL_LYRICS_SITE, Id3FieldType.TEXT),
 65  4
     DISC_TOTAL(ID3v24Frames.FRAME_ID_SET, Id3FieldType.TEXT),
 66  4
     TRACK_TOTAL(ID3v24Frames.FRAME_ID_TRACK, Id3FieldType.TEXT),
 67  
     ;
 68  
     private String fieldName;
 69  
 
 70  
     private String frameId;
 71  
     private String subId;
 72  
     private Id3FieldType fieldType;
 73  
 
 74  
     /**
 75  
      * For usual metadata fields that use a data field
 76  
      *
 77  
      * @param frameId   the frame that will be used
 78  
      * @param fieldType of data atom
 79  
      */
 80  
     ID3v24FieldKey(String frameId, Id3FieldType fieldType)
 81  132
     {
 82  132
         this.frameId = frameId;
 83  132
         this.fieldType = fieldType;
 84  
 
 85  132
         this.fieldName = frameId;
 86  132
     }
 87  
 
 88  
     /**
 89  
      * @param frameId   the frame that will be used
 90  
      * @param subId     the additional key required within the frame to uniquely identify this key
 91  
      * @param fieldType
 92  
      */
 93  
     ID3v24FieldKey(String frameId, String subId, Id3FieldType fieldType)
 94  72
     {
 95  72
         this.frameId = frameId;
 96  72
         this.subId = subId;
 97  72
         this.fieldType = fieldType;
 98  
 
 99  72
         this.fieldName = frameId + ":" + subId;
 100  72
     }
 101  
 
 102  
     /**
 103  
      * @return fieldtype
 104  
      */
 105  
     public Id3FieldType getFieldType()
 106  
     {
 107  0
         return fieldType;
 108  
     }
 109  
 
 110  
     /**
 111  
      * This is the frame identifier used to write the field
 112  
      *
 113  
      * @return
 114  
      */
 115  
     public String getFrameId()
 116  
     {
 117  771
         return frameId;
 118  
     }
 119  
 
 120  
     /**
 121  
      * This is the subfield used within the frame for this type of field
 122  
      *
 123  
      * @return subId
 124  
      */
 125  
     public String getSubId()
 126  
     {
 127  771
         return subId;
 128  
     }
 129  
 
 130  
     /**
 131  
      * This is the value of the key that can uniquely identifer a key type
 132  
      *
 133  
      * @return
 134  
      */
 135  
     public String getFieldName()
 136  
     {
 137  24
         return fieldName;
 138  
     }
 139  
 }