org.farng.mp3.id3
Class FrameBodyGRID

java.lang.Object
  org.farng.mp3.AbstractMP3FileItem
      org.farng.mp3.AbstractMP3FragmentBody
          org.farng.mp3.id3.AbstractID3v2FrameBody
              org.farng.mp3.id3.FrameBodyGRID

public class FrameBodyGRID

extends AbstractID3v2FrameBody

4.26. Group identification registration

This frame enables grouping of otherwise unrelated frames. This can

be used when some frames are to be signed. To identify which frames
belongs to a set of frames a group identifier must be registered in
the tag with this frame. The 'Owner identifier' is a null-terminated
string with a URL [URL] containing an email address, or a link to a
location where an email address can be found, that belongs to the

organisation responsible for this grouping. Questions regarding the
grouping should be sent to the indicated email address. The 'Group
symbol' contains a value that associates the frame with this group
throughout the whole tag, in the range $80-F0. All other values are
reserved. The 'Group symbol' may optionally be followed by some group

specific data, e.g. a digital signature. There may be several "GRID"
frames in a tag but only one containing the same symbol and only one
containing the same owner identifier. The group symbol must be used
somewhere in the tag. See the description of the frame grouping flag

in the ID3v2 structure document [ID3v2-strct] for more information.

<Header for 'Group ID registration', ID: "GRID">
Owner identifier <text string> $00

Group symbol $xx
Group dependent data <binary data>

Version:

$Revision: 1.4 $

Author:

Eric Farng

Constructor Summary

FrameBodyGRID()
Creates a new FrameBodyGRID object.

FrameBodyGRID(FrameBodyGRID body)
Creates a new FrameBodyGRID object.

FrameBodyGRID(java.io.RandomAccessFile file)
Creates a new FrameBodyGRID object.

FrameBodyGRID(java.lang.String owner, byte groupSymbol, byte[] data)
Creates a new FrameBodyGRID object.

Method Summary

byte	getGroupSymbol()
java.lang.String	getIdentifier() ID string that usually corresponds to the class name, but can be displayed to the user.
java.lang.String	getOwner()
void	setGroupSymbol(byte textEncoding)
void	setOwner(java.lang.String owner)
protected void	setupObjectList() Create the order of MP3Object objects that this body expects.

Methods inherited from class org.farng.mp3.id3.AbstractID3v2FrameBody

equals, readHeader, writeHeader

Methods inherited from class org.farng.mp3.AbstractMP3FragmentBody

appendToObjectList, getBriefDescription, getDescription, getObject, getObjectListIterator, getSize, has6ByteHeader, isSubsetOf, iterator, read, setObject, toString, write

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameBodyGRID

public FrameBodyGRID()

Creates a new FrameBodyGRID object.

FrameBodyGRID

public FrameBodyGRID(FrameBodyGRID body)

Creates a new FrameBodyGRID object.

FrameBodyGRID

public FrameBodyGRID(java.lang.String owner,
                     byte groupSymbol,
                     byte[] data)

Creates a new FrameBodyGRID object.

FrameBodyGRID

public FrameBodyGRID(java.io.RandomAccessFile file)
              throws java.io.IOException,
                     InvalidTagException

Creates a new FrameBodyGRID object.

Method Detail

setGroupSymbol

public void setGroupSymbol(byte textEncoding)

getGroupSymbol

public byte getGroupSymbol()

getIdentifier

public java.lang.String getIdentifier()

Description copied from class: AbstractMP3FileItem

ID string that usually corresponds to the class name, but can be displayed to the user. It is not indended to identify each individual instance.

Specified by:

getIdentifier in class AbstractMP3FileItem

Returns:

ID string

setOwner

public void setOwner(java.lang.String owner)

getOwner

public java.lang.String getOwner()

setupObjectList

protected void setupObjectList()

Description copied from class: AbstractMP3FragmentBody

Create the order of MP3Object objects that this body expects. This method needs to be overwritten.

Specified by:

setupObjectList in class AbstractMP3FragmentBody