/**
* Licensed to The Apereo Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
*
* The Apereo Foundation licenses this file to you under the Educational
* Community License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of the License
* at:
*
* http://opensource.org/licenses/ecl2.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*
*/
package org.opencastproject.metadata.mpeg7;
import org.opencastproject.mediapackage.XmlElement;
/**
* Textual is a generic text type:
*
* <pre>
* <complexType name="TextualBaseType" abstract="true">
* <simpleContent>
* <extension base="string">
* <attribute ref="xml:lang" use="optional"/>
* <attribute name="phoneticTranscription" use="optional">
* <simpleType>
* <list itemType="mpeg7:PhoneType"/>
* </simpleType>
* </attribute>
* <attribute name="phoneticAlphabet" type="mpeg7:phoneticAlphabetType" use="optional" default="sampa"/>
* </extension>
* </simpleContent>
* </complexType>
* </pre>
*/
public interface Textual extends XmlElement {
/**
* Sets the text.
*
* @param text
* the text
*/
void setText(String text);
/**
* Returns the actual text.
*
* @return the text
*/
String getText();
/**
* Sets the language, which must correspond to the defininition of <code>xml:lang</code>.
*
* @param language
* the language
*/
void setLanguage(String language);
/**
* Returns the text's language.
*
* @return the language
*/
String getLanguage();
/**
* Sets the phonetic transcription and specifies which alphabet was used to produce it.
*
* @param transcription
* the transcription
* @param alphabet
* the alphabet
*/
void setPhoneticTranscription(String transcription, String alphabet);
/**
* Returns the optional phonetic transcription.
*
* @return the phonetic transcription
*/
String getPhoneticTranscription();
/**
* Returns the optional phonetic alphabet or the default value <code>sampa</code> if no alphabet has been specified.
*
* @return the phonetic alphabet
*/
String getPhoneticAlphabet();
}