Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> virtuosotechnologies >> asaph >> [ standardmodel overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.virtuosotechnologies.asaph.standardmodel
Interface StandardModelFactory  

All Known Implementing Classes:

StandardModelFactoryImpl

---

public interface StandardModelFactory

API for StandardModel

---

Field Summary
static java.lang.String	API_NAME           Name of this API

 

Method Summary
com.virtuosotechnologies.asaph.model.SongDatabase	createSimpleSongDatabase()           Create a simple SongDatabase implementation.
com.virtuosotechnologies.asaph.model.Song	createSong(com.virtuosotechnologies.asaph.model.SongID id, java.util.Locale locale)           Create a standard Song implementation.
com.virtuosotechnologies.asaph.model.SongIDResultSet	createSongIDResultSet(com.virtuosotechnologies.asaph.model.SongDatabase database)           Create a standard SongIDResultSet implementation.
com.virtuosotechnologies.lib.util.StringID	getSongVersion(com.virtuosotechnologies.asaph.model.Song song)           Get the version string for the given Song.
boolean	isSimpleSongDatabase(com.virtuosotechnologies.asaph.model.SongDatabase database)           Returns true if the given Song is a simple implementation of SongDatabase.
boolean	isStandardModelSong(com.virtuosotechnologies.asaph.model.Song song)           Returns true if the given Song is a StandardModel implementation of Song.
com.virtuosotechnologies.asaph.model.SongDatabase	parseSimpleSongDatabase(java.io.Reader reader, org.xml.sax.ErrorHandler errorHandler, boolean writable)           Parse a simple SongDatabase from the given XML document.
com.virtuosotechnologies.asaph.model.Song	parseSong(java.io.Reader reader, com.virtuosotechnologies.asaph.model.SongID id, org.xml.sax.ErrorHandler errorHandler)           Parse a Song from the given XML document.
void	setSongVersion(com.virtuosotechnologies.asaph.model.Song song, com.virtuosotechnologies.lib.util.StringID version)           Set the version string for the given Song.
void	unparseSimpleSongDatabase(com.virtuosotechnologies.asaph.model.SongDatabase database, java.io.OutputStream stream, java.lang.String encodingName)           Unparse the given SongDatabase to an OutputStream as a standalone XML file.
void	unparseSimpleSongDatabase(com.virtuosotechnologies.asaph.model.SongDatabase database, java.io.Writer writer, java.lang.String encodingName)           Unparse the given SongDatabase to an OutputStream as a standalone XML file.
void	unparseSong(com.virtuosotechnologies.asaph.model.Song song, java.io.OutputStream stream, java.lang.String encodingName)           Unparse the given Song to an OutputStream as a standalone XML file.
void	unparseSong(com.virtuosotechnologies.asaph.model.Song song, java.io.Writer writer, java.lang.String encodingName)           Unparse the given Song to an OutputStream as a standalone XML file.
void	unparseSongElement(com.virtuosotechnologies.asaph.model.Song song, com.virtuosotechnologies.lib.xml.XMLUnparser unparser)           Unparse the given Song to an OutputStream as an element within a larger XML document.

 

Field Detail

API_NAME

public static final java.lang.String API_NAME

Name of this API

See Also:

Constant Field Values

Method Detail

createSongIDResultSet

public com.virtuosotechnologies.asaph.model.SongIDResultSet createSongIDResultSet(com.virtuosotechnologies.asaph.model.SongDatabase database)

Create a standard SongIDResultSet implementation.

---

createSong

public com.virtuosotechnologies.asaph.model.Song createSong(com.virtuosotechnologies.asaph.model.SongID id,
                                                            java.util.Locale locale)

Create a standard Song implementation.

---

parseSong

public com.virtuosotechnologies.asaph.model.Song parseSong(java.io.Reader reader,
                                                           com.virtuosotechnologies.asaph.model.SongID id,
                                                           org.xml.sax.ErrorHandler errorHandler)
                                                    throws java.io.IOException,
                                                           org.xml.sax.SAXException

Parse a Song from the given XML document.

---

isStandardModelSong

public boolean isStandardModelSong(com.virtuosotechnologies.asaph.model.Song song)

Returns true if the given Song is a StandardModel implementation of Song. This means the song unparse operations provided by this API may be performed.

---

unparseSong

public void unparseSong(com.virtuosotechnologies.asaph.model.Song song,
                        java.io.OutputStream stream,
                        java.lang.String encodingName)
                 throws java.io.IOException

Unparse the given Song to an OutputStream as a standalone XML file. The Song must be a StandardModel Song.

---

unparseSong

public void unparseSong(com.virtuosotechnologies.asaph.model.Song song,
                        java.io.Writer writer,
                        java.lang.String encodingName)
                 throws java.io.IOException

Unparse the given Song to an OutputStream as a standalone XML file. The Song must be a StandardModel Song. Does not check to ensure the given writer's encoding matches the encoding string.

---

unparseSongElement

public void unparseSongElement(com.virtuosotechnologies.asaph.model.Song song,
                               com.virtuosotechnologies.lib.xml.XMLUnparser unparser)
                        throws java.io.IOException

Unparse the given Song to an OutputStream as an element within a larger XML document. The Song must be a StandardModel Song.

---

getSongVersion

public com.virtuosotechnologies.lib.util.StringID getSongVersion(com.virtuosotechnologies.asaph.model.Song song)

Get the version string for the given Song. The Song must be a StandardModel Song.

---

setSongVersion

public void setSongVersion(com.virtuosotechnologies.asaph.model.Song song,
                           com.virtuosotechnologies.lib.util.StringID version)

Set the version string for the given Song. The Song must be a StandardModel Song.

---

createSimpleSongDatabase

public com.virtuosotechnologies.asaph.model.SongDatabase createSimpleSongDatabase()

Create a simple SongDatabase implementation.

---

parseSimpleSongDatabase

public com.virtuosotechnologies.asaph.model.SongDatabase parseSimpleSongDatabase(java.io.Reader reader,
                                                                                 org.xml.sax.ErrorHandler errorHandler,
                                                                                 boolean writable)
                                                                          throws java.io.IOException,
                                                                                 org.xml.sax.SAXException

Parse a simple SongDatabase from the given XML document.

---

isSimpleSongDatabase

public boolean isSimpleSongDatabase(com.virtuosotechnologies.asaph.model.SongDatabase database)

Returns true if the given Song is a simple implementation of SongDatabase. This means the song database unparse operations provided by this API may be performed.

---

unparseSimpleSongDatabase

public void unparseSimpleSongDatabase(com.virtuosotechnologies.asaph.model.SongDatabase database,
                                      java.io.OutputStream stream,
                                      java.lang.String encodingName)
                               throws java.io.IOException

Unparse the given SongDatabase to an OutputStream as a standalone XML file. The database must be a simple SongDatabase.

---

unparseSimpleSongDatabase

public void unparseSimpleSongDatabase(com.virtuosotechnologies.asaph.model.SongDatabase database,
                                      java.io.Writer writer,
                                      java.lang.String encodingName)
                               throws java.io.IOException

Unparse the given SongDatabase to an OutputStream as a standalone XML file. The database must be a simple SongDatabase. Does not check to ensure the given writer's encoding matches the encoding string.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> virtuosotechnologies >> asaph >> [ standardmodel overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---