|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object fr.gouv.culture.sdx.utils.AbstractSdxObject
public abstract class AbstractSdxObject
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface fr.gouv.culture.sdx.utils.SdxObject |
---|
SdxObject.ConfigurationNode |
Field Summary | |
---|---|
protected org.apache.avalon.framework.configuration.Configuration |
_configuration
|
protected org.apache.avalon.framework.context.DefaultContext |
_context
|
protected org.apache.excalibur.source.Source |
_description
|
protected java.lang.String |
_encoding
The default encoding to be used when working with strings |
protected java.lang.String |
_id
|
protected java.util.Locale |
_locale
|
protected org.apache.avalon.framework.logger.Logger |
_logger
Avalon logger to write information. |
protected org.apache.avalon.framework.service.ServiceManager |
_manager
|
protected java.util.HashMap |
_xmlizable_objects
|
protected java.lang.String |
_xmlLang
|
protected boolean |
isToSaxInitialized
|
Fields inherited from interface fr.gouv.culture.sdx.utils.Encodable |
---|
DEFAULT_ENCODING |
Constructor Summary | |
---|---|
AbstractSdxObject()
|
Method Summary | |
---|---|
void |
configure(org.apache.avalon.framework.configuration.Configuration configuration)
|
protected void |
configureDescription(org.apache.avalon.framework.configuration.Configuration configuration)
|
void |
contextualize(org.apache.avalon.framework.context.Context context)
|
void |
enableLogging(org.apache.avalon.framework.logger.Logger logger)
Sets the super.getLog() for this object. |
protected org.xml.sax.Attributes |
getBaseAttributes()
Returns an SAX Attributes object containing the xml:lang, id, locale, encoding |
protected abstract java.lang.String |
getClassNameSuffix()
Sub classes should element this method to return their class name suffix for SAX output |
protected org.apache.avalon.framework.configuration.Configuration |
getConfiguration()
|
protected org.apache.avalon.framework.context.DefaultContext |
getContext()
|
org.apache.excalibur.source.Source |
getDescription()
|
java.lang.String |
getEncoding()
|
java.lang.String |
getId()
|
java.util.Locale |
getLocale()
|
org.apache.avalon.framework.logger.Logger |
getLog()
|
protected org.apache.avalon.framework.service.ServiceManager |
getServiceManager()
|
java.lang.String |
getXmlLang()
Returns the xml:lang attibute value from the configuration |
protected abstract boolean |
initToSax()
Init the LinkedHashMap _xmlizable_objects with the objects in order to describ them in XML |
protected abstract void |
initVolatileObjectsToSax()
Init the LinkedHashMap _xmlizable_volatile_objects with the objects in order to describ them in XML Some objects need to be refresh each time a toSAX is called |
void |
service(org.apache.avalon.framework.service.ServiceManager serviceManager)
|
void |
setDescription(org.apache.excalibur.source.Source description)
|
void |
setEncoding(java.lang.String encoding)
|
void |
setId(java.lang.String id)
|
void |
setLocale(java.util.Locale locale)
|
protected SdxObject |
setUpSdxObject(SdxObject sdxObj)
|
protected SdxObject |
setUpSdxObject(SdxObject sdxObj,
org.apache.avalon.framework.configuration.Configuration configuration)
|
void |
setXmlLang(java.lang.String lang)
|
void |
toSAX(org.xml.sax.ContentHandler contentHandler)
|
protected void |
verifyConfigurationResources()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected transient org.apache.avalon.framework.logger.Logger _logger
protected transient org.apache.avalon.framework.context.DefaultContext _context
protected transient org.apache.avalon.framework.service.ServiceManager _manager
protected transient org.apache.avalon.framework.configuration.Configuration _configuration
protected java.lang.String _id
protected java.lang.String _encoding
protected java.util.Locale _locale
protected java.lang.String _xmlLang
protected transient org.apache.excalibur.source.Source _description
protected transient java.util.HashMap _xmlizable_objects
protected boolean isToSaxInitialized
Constructor Detail |
---|
public AbstractSdxObject()
Method Detail |
---|
public void enableLogging(org.apache.avalon.framework.logger.Logger logger)
Setting the super.getLog() ensures proper logging of potential errors. If not set, this class won't be able to log any information. But it will still work.
enableLogging
in interface org.apache.avalon.framework.logger.LogEnabled
public void contextualize(org.apache.avalon.framework.context.Context context) throws org.apache.avalon.framework.context.ContextException
contextualize
in interface org.apache.avalon.framework.context.Contextualizable
org.apache.avalon.framework.context.ContextException
public void service(org.apache.avalon.framework.service.ServiceManager serviceManager) throws org.apache.avalon.framework.service.ServiceException
service
in interface org.apache.avalon.framework.service.Serviceable
org.apache.avalon.framework.service.ServiceException
public void configure(org.apache.avalon.framework.configuration.Configuration configuration) throws org.apache.avalon.framework.configuration.ConfigurationException
configure
in interface org.apache.avalon.framework.configuration.Configurable
org.apache.avalon.framework.configuration.ConfigurationException
protected void configureDescription(org.apache.avalon.framework.configuration.Configuration configuration) throws org.apache.avalon.framework.configuration.ConfigurationException
org.apache.avalon.framework.configuration.ConfigurationException
public void setId(java.lang.String id) throws SDXException
setId
in interface Identifiable
SDXException
public void setDescription(org.apache.excalibur.source.Source description)
setDescription
in interface Describable
public void setEncoding(java.lang.String encoding)
setEncoding
in interface Encodable
public void setLocale(java.util.Locale locale)
setLocale
in interface Localizable
public void setXmlLang(java.lang.String lang)
setXmlLang
in interface Localizable
public org.apache.avalon.framework.logger.Logger getLog()
getLog
in interface SdxObject
protected org.apache.avalon.framework.context.DefaultContext getContext()
protected org.apache.avalon.framework.service.ServiceManager getServiceManager()
protected org.apache.avalon.framework.configuration.Configuration getConfiguration()
public java.util.Locale getLocale()
getLocale
in interface Localizable
public java.lang.String getId()
getId
in interface Identifiable
public java.lang.String getEncoding()
getEncoding
in interface Encodable
public org.apache.excalibur.source.Source getDescription()
getDescription
in interface Describable
public java.lang.String getXmlLang()
getXmlLang
in interface Localizable
protected org.xml.sax.Attributes getBaseAttributes()
protected abstract java.lang.String getClassNameSuffix()
protected abstract boolean initToSax()
protected abstract void initVolatileObjectsToSax()
public void toSAX(org.xml.sax.ContentHandler contentHandler) throws org.xml.sax.SAXException
toSAX
in interface org.apache.excalibur.xml.sax.XMLizable
org.xml.sax.SAXException
protected SdxObject setUpSdxObject(SdxObject sdxObj) throws org.apache.avalon.framework.configuration.ConfigurationException
org.apache.avalon.framework.configuration.ConfigurationException
protected SdxObject setUpSdxObject(SdxObject sdxObj, org.apache.avalon.framework.configuration.Configuration configuration) throws org.apache.avalon.framework.configuration.ConfigurationException
org.apache.avalon.framework.configuration.ConfigurationException
protected void verifyConfigurationResources() throws org.apache.avalon.framework.configuration.ConfigurationException
org.apache.avalon.framework.configuration.ConfigurationException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |