File Doc Category Size Date Package
FrameBodyTPOS.java API Doc Jaudiotagger 2.0.4 4815 Wed Mar 30 16:12:02 BST 2011 org.jaudiotagger.tag.id3.framebody

FrameBodyTPOS

java.lang.Object
- AbstractID3v2FrameBody

public class FrameBodyTPOS extends AbstractID3v2FrameBody implements ID3v24FrameBody, ID3v23FrameBody

Part of a set Text information frame.

The 'Part of a set' frame is a numeric string that describes which part of a set the audio came from. This frame is used if the source described in the "TALB" frame is divided into several mediums, e.g. a double CD. The value may be extended with a "/" character and a numeric string containing the total number of parts in the set. e.g. "1/2".

For more details, please refer to the ID3 specifications:

ID3 v2.3.0 Spec

author: : Paul Taylor
author: : Eric Farng
version: $Id: FrameBodyTPOS.java 895 2010-04-15 15:21:45Z paultaylor $

Fields Summary
Constructors Summary
public FrameBodyTPOS()
Creates a new FrameBodyTRCK datatype.
setObjectValue(DataTypes.OBJ_TEXT_ENCODING, TextEncoding.ISO_8859_1); setObjectValue(DataTypes.OBJ_TEXT, new PartOfSet.PartOfSetValue());
public FrameBodyTPOS(FrameBodyTPOS body)
super(body);
public FrameBodyTPOS(byte textEncoding, String text)
Creates a new FrameBodyTRCK datatype, the value is parsed literally
param
textEncoding
param
text
setObjectValue(DataTypes.OBJ_TEXT_ENCODING, textEncoding); setObjectValue(DataTypes.OBJ_TEXT, new PartOfSet.PartOfSetValue(text));
public FrameBodyTPOS(byte textEncoding, Integer discNo, Integer discTotal)
super(); setObjectValue(DataTypes.OBJ_TEXT_ENCODING, textEncoding); setObjectValue(DataTypes.OBJ_TEXT, new PartOfSet.PartOfSetValue(discNo,discTotal));
public FrameBodyTPOS(ByteBuffer byteBuffer, int frameSize)
Creates a new FrameBodyTRCK datatype.
param
byteBuffer
param
frameSize
throws
java.io.IOException
throws
InvalidTagException
super(byteBuffer, frameSize);
Methods Summary
public java.lang.Integer getDiscNo()
return ((PartOfSet.PartOfSetValue)getObjectValue(DataTypes.OBJ_TEXT)).getCount();
public java.lang.Integer getDiscTotal()
return ((PartOfSet.PartOfSetValue)getObjectValue(DataTypes.OBJ_TEXT)).getTotal();
public java.lang.String getIdentifier()
The ID3v2 frame identifier
return
the ID3v2 frame identifier for this frame type
return ID3v24Frames.FRAME_ID_SET;
public java.lang.String getText()
return getObjectValue(DataTypes.OBJ_TEXT).toString();
public java.lang.String getUserFriendlyValue()
return String.valueOf(getDiscNo());
public void setDiscNo(java.lang.Integer discNo)
((PartOfSet.PartOfSetValue)getObjectValue(DataTypes.OBJ_TEXT)).setCount(discNo);
public void setDiscTotal(java.lang.Integer discTotal)
((PartOfSet.PartOfSetValue)getObjectValue(DataTypes.OBJ_TEXT)).setTotal(discTotal);
public void setText(java.lang.String text)
setObjectValue(DataTypes.OBJ_TEXT, new PartOfSet.PartOfSetValue(text));
protected void setupObjectList()
objectList.add(new NumberHashMap(DataTypes.OBJ_TEXT_ENCODING, this, TextEncoding.TEXT_ENCODING_FIELD_SIZE)); objectList.add(new PartOfSet(DataTypes.OBJ_TEXT, this));