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