|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.p13n.model.DefaultDocumentModel com.bea.p13n.placeholder.model.PlaceholderModelDocument
public class PlaceholderModelDocument
A default model document for PlaceholderModels. This also provides common methods for parsing and writing placeholder xml in the preferred manner.
Field Summary | |
---|---|
static String |
schemaLocation
The xsi:schemaLocation value for placeholder documents. |
static Map<String,String> |
suggestedPrefixes
The unmodifiable map of namespace uri to preferred prefix for placeholder xml. |
Constructor Summary | |
---|---|
PlaceholderModelDocument(InputStream in)
Constructor from an input stream. |
|
PlaceholderModelDocument(PlaceholderModel ph)
Constructor from PlaceholderModel. |
|
PlaceholderModelDocument(Reader in)
Constructor from an input reader. |
|
PlaceholderModelDocument(String in)
Constructor from xml. |
Method Summary | |
---|---|
static org.apache.xmlbeans.XmlOptions |
getSaveOptions()
Get default XmlOptions for saving/outputting placeholder xml. |
static PlaceholderModel |
parsePlaceholderModel(InputStream xml,
Collection errors)
Parse a placeholder model from an input stream |
static PlaceholderModel |
parsePlaceholderModel(Reader xml,
Collection errors)
Parse a placeholder model from a reader. |
static PlaceholderModel |
parsePlaceholderModel(String xml,
Collection errors)
Parse a placeholder model from xml. |
static com.bea.p13n.placeholder.schema.PlaceholderDocument |
prepareForSave(PlaceholderModel ph,
String encoding,
org.apache.xmlbeans.XmlOptions opts)
Prepare a PlaceholderDocument xml object from the PlaceholderModel. |
static InputStream |
toInputStream(PlaceholderModel ph)
Get an input stream of the specified PlaceholderModel's xml. |
static InputStream |
toInputStream(PlaceholderModel ph,
String encoding)
Get an input stream of the specified PlaceholderModel's xml. |
static Reader |
toReader(PlaceholderModel ph)
Get a reader of the specified PlaceholderModel's xml. |
static Reader |
toReader(PlaceholderModel ph,
String encoding)
Get a reader of the specified PlaceholderModel's xml. |
static String |
toString(PlaceholderModel ph)
Get the specified PlaceholderModel's xml. |
static String |
toString(PlaceholderModel ph,
String encoding)
Get the specified PlaceholderModel's xml. |
Methods inherited from class com.bea.p13n.model.DefaultDocumentModel |
---|
addChangeListener, getRootModel, modelChildAdded, modelChildRemoved, modelPropertyChanged, removeChangeListener, setRootModel |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final Map<String,String> suggestedPrefixes
public static final String schemaLocation
Constructor Detail |
---|
public PlaceholderModelDocument(PlaceholderModel ph)
public PlaceholderModelDocument(Reader in) throws org.apache.xmlbeans.XmlException, IllegalArgumentException, IOException
org.apache.xmlbeans.XmlException
- on a parsing exception
IllegalArgumentException
- if the xml is not valid for PlaceholderModel.
IOException
- on an error reading from the stream.public PlaceholderModelDocument(InputStream in) throws org.apache.xmlbeans.XmlException, IllegalArgumentException, IOException
org.apache.xmlbeans.XmlException
- on a parsing exception
IllegalArgumentException
- if the xml is not valid for PlaceholderModel.
IOException
- on an error reading from the stream.public PlaceholderModelDocument(String in) throws org.apache.xmlbeans.XmlException, IllegalArgumentException
org.apache.xmlbeans.XmlException
- on a parsing exception
IllegalArgumentException
- if the xml is not valid for PlaceholderModel.Method Detail |
---|
public static PlaceholderModel parsePlaceholderModel(String xml, Collection errors) throws org.apache.xmlbeans.XmlException, IllegalArgumentException
xml
- the xml string.errors
- a collection to store any XmlErrors from the parse.
org.apache.xmlbeans.XmlException
- on a parsing exception
IllegalArgumentException
- if the xml is not valid for
PlaceholderModel.public static PlaceholderModel parsePlaceholderModel(Reader xml, Collection errors) throws org.apache.xmlbeans.XmlException, IllegalArgumentException, IOException
xml
- the xml readererrors
- a collection to store any XmlErrors from the parse.
org.apache.xmlbeans.XmlException
- on a parsing exception.
IllegalArgumentException
- if the xml is not valid for
PlaceholderModel.
IOException
- on an error reading from the stream.public static PlaceholderModel parsePlaceholderModel(InputStream xml, Collection errors) throws org.apache.xmlbeans.XmlException, IllegalArgumentException, IOException
xml
- the xml input stream.errors
- a collection to store any XmlErrors from the parse.
org.apache.xmlbeans.XmlException
- on a parsing exception.
IllegalArgumentException
- if the xml is not valid for
PlaceholderModel.
IOException
- on an error reading from the stream.public static org.apache.xmlbeans.XmlOptions getSaveOptions()
suggestedPrefixes
public static com.bea.p13n.placeholder.schema.PlaceholderDocument prepareForSave(PlaceholderModel ph, String encoding, org.apache.xmlbeans.XmlOptions opts)
ph
- the placeholder model.encoding
- the encoding to use, null for default.opts
- the opts to modify appropriately.public static InputStream toInputStream(PlaceholderModel ph)
public static InputStream toInputStream(PlaceholderModel ph, String encoding)
public static Reader toReader(PlaceholderModel ph)
public static Reader toReader(PlaceholderModel ph, String encoding)
ph
- the placeholder model.encoding
- the character encoding to use, null for model's default
encodingpublic static String toString(PlaceholderModel ph)
public static String toString(PlaceholderModel ph, String encoding)
ph
- the placeholder model.encoding
- the character encoding to use, null for model's default
encoding
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |