oracle.javatools.resourcebundle.impl

Class XliffResourceBundleWrapper

java.lang.Object

oracle.javatools.resourcebundle.ResourceBundleWrapperRT

oracle.javatools.resourcebundle.impl.XliffResourceBundleWrapper

All Implemented Interfaces:

ResourceBundleWrapper, SearchSupport

Direct Known Subclasses:

CachedXliffResourceBundleWrapper, CompBundleCachedXliffResourceBundleWrapper

public class XliffResourceBundleWrapper
extends ResourceBundleWrapperRT

The XliffResourceBundleWrapper provides a run-time implementation of a ResourceBundleWrapper for .xlf files. The .xlf file is expected to use the "id" attribute in the "trans-unit" node to store the "key" value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	XliffResourceBundleWrapper.ResourceBundleAuditEvents

Nested classes/interfaces inherited from class oracle.javatools.resourcebundle.ResourceBundleWrapperRT

ResourceBundleWrapperRT.DefaultSearchContext, ResourceBundleWrapperRT.SearchType

Nested classes/interfaces inherited from interface oracle.javatools.resourcebundle.ResourceBundleWrapper

ResourceBundleWrapper.KeyInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_writable

Fields inherited from class oracle.javatools.resourcebundle.ResourceBundleWrapperRT

_parent

Constructor Summary

Constructors

Constructor and Description
XliffResourceBundleWrapper()
XliffResourceBundleWrapper(oracle.mds.core.MOKey mokey, java.util.Locale locale) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	addEntry(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata) Adds a new entry (key, value, and optional metadata) into the resource bundle.
ResourceBundleOperationResult	addEntryNoDialog(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata) Adds a new entry (key, value, and optional metadata) into the resource bundle.
protected void	addMetadata(org.w3c.dom.Element element, java.util.Map<java.lang.String,java.lang.String> metadata)
protected oracle.mds.core.MOReference	createMOReference(java.lang.String appOverrideFile)
boolean	deleteEntry(java.lang.String key) Deletes the resource bundle entry identified by key.
protected java.util.Map<java.lang.String,ResourceBundleWrapper.KeyInfo>	getBaseKeyMap()
protected java.util.Map<java.lang.String,java.lang.String>	getBaseKeyValueMap()
protected java.lang.String	getBundleIdentifier()
protected org.w3c.dom.Document	getDocument()
java.util.Map<java.lang.String,java.lang.String>	getKeyValueMap() Gets the map of key-values for this bundle.
java.util.Map<java.lang.String,java.lang.String>	getMetadata(java.lang.String key) Gets the translated text (value) identified by key
protected oracle.mds.core.MetadataObject	getMetadataObject(oracle.mds.core.MDSSession mdsSession, java.lang.String fileName)
protected oracle.mds.core.MetadataObject	getMetadataObject(oracle.mds.core.MDSSession mdsSession, java.lang.String fileName, boolean writable)
oracle.mds.core.MOKey	getMOKey()
protected oracle.mds.core.MetadataObject	getMutableMO(oracle.mds.core.MDSSession mdsSession, oracle.mds.core.MOReference moRef, java.lang.String custLayerName, java.lang.String custLayerValue)
java.lang.String	getString(java.lang.String key) Gets the translated text (value) identified by key
java.util.Set<java.lang.String>	keySet() Returns a set view of the keys contained in this resource bundle.
void	parse(org.w3c.dom.Document document)
void	parse(org.w3c.dom.Document document, java.util.Map<java.lang.String,ResourceBundleWrapper.KeyInfo> keyMap, java.util.Map<java.lang.String,java.lang.String> keyValueMap)
void	parse(java.net.URL url)
void	setDocument(org.w3c.dom.Document document) This should only be used when dealing with an override bundle and via the AppBundleInfoRT class
void	setParent(ResourceBundleWrapperRT parentBundle)
void	setWritable(boolean writable)
void	updateDocument(org.w3c.dom.Document document)
boolean	updateEntry(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata) Updates the specified key to have the specified text and metadata.
boolean	updateEntry(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> note, CustomizationHint hint) Only for string editor use.
protected boolean	updateEntry(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata, oracle.mds.core.MetadataObject metadataObject) Only for string editor use.
ResourceBundleOperationResult	updateEntryNoDialog(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata) Updates the specified key to have the specified text and metadata while not showing any dialog
ResourceBundleOperationResult	updateEntryNoDialog(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata, CustomizationHint hint)

Methods inherited from class oracle.javatools.resourcebundle.ResourceBundleWrapperRT

addEntry, addResourceBundleListener, findKeys, findKeys, findKeysByMetaData, findKeysByMetaData, findKeysByText, findKeysByText, findKeysLikeKey, findKeysLikeKey, findKeysLikeMetaData, findKeysLikeText, findKeysLikeText, getBaseBundleKeyValueMap, getBundleId, getChainedKeyValueMap, getChainedKeyValueMapNoOverride, getChainedKeyValueNoteMap, getExportChainedKeyValueNoteMap, getKeyGenerator, getKeyMapForExport, getKeyMapForFABundleExport, getKeyValueNoteMap, getKeyValueNoteMap, getKeyValueNoteMapFromFABundle, getKeyValueNoteMapFromFABundleChain, getMetadataFromParentChain, getMetadataObject, getMOReference, getMostSpecificWrapperMoName, getParent, getParentChain, getParentList, getSEChainedKeyValueMap, isEmptyReadOnlyWrapper, refreshBundleIfNeeded, removeResourceBundleListener, setBundleId, setEmptyReadOnlyWrapper, setKeyGenerator, setParentList, setURL, toString, updateEntryExport, updateEntryImport

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_writable

protected boolean _writable

Constructor Detail

XliffResourceBundleWrapper

public XliffResourceBundleWrapper()

XliffResourceBundleWrapper

@Deprecated
public XliffResourceBundleWrapper(oracle.mds.core.MOKey mokey,
                                              java.util.Locale locale)

Deprecated.

Method Detail

getMOKey

public oracle.mds.core.MOKey getMOKey()

getBundleIdentifier

protected java.lang.String getBundleIdentifier()

createMOReference

protected oracle.mds.core.MOReference createMOReference(java.lang.String appOverrideFile)

getMetadataObject

protected oracle.mds.core.MetadataObject getMetadataObject(oracle.mds.core.MDSSession mdsSession,
                                                           java.lang.String fileName)

getMetadataObject

protected oracle.mds.core.MetadataObject getMetadataObject(oracle.mds.core.MDSSession mdsSession,
                                                           java.lang.String fileName,
                                                           boolean writable)

getBaseKeyMap

protected java.util.Map<java.lang.String,ResourceBundleWrapper.KeyInfo> getBaseKeyMap()

getBaseKeyValueMap

protected java.util.Map<java.lang.String,java.lang.String> getBaseKeyValueMap()

addEntry

public boolean addEntry(java.lang.String key,
                        java.lang.String text,
                        java.util.Map<java.lang.String,java.lang.String> metadata)
                 throws java.lang.UnsupportedOperationException

Description copied from interface: ResourceBundleWrapper

Adds a new entry (key, value, and optional metadata) into the resource bundle. May show a dialog if the key is being written into an "override" bundle and the warning dialog's "Don't show me this next time" checkbox has not been previously checked.

Specified by:

addEntry in interface ResourceBundleWrapper

Overrides:

addEntry in class ResourceBundleWrapperRT

Parameters:

key - The key name to use in the resource bundle.

text - The text to be translated.

metadata - Any associated metadata about the translation string This parameter may be null

Returns:

true on success

Throws:

java.lang.UnsupportedOperationException

addEntryNoDialog

public ResourceBundleOperationResult addEntryNoDialog(java.lang.String key,
                                                      java.lang.String text,
                                                      java.util.Map<java.lang.String,java.lang.String> metadata)

Description copied from interface: ResourceBundleWrapper

Adds a new entry (key, value, and optional metadata) into the resource bundle. May show a dialog if the key is being written into an "override" bundle and the warning dialog's "Don't show me this next time" checkbox has not been previously checked.

Specified by:

addEntryNoDialog in interface ResourceBundleWrapper

Overrides:

addEntryNoDialog in class ResourceBundleWrapperRT

Parameters:

key - The key name to use in the resource bundle.

text - The text to be translated.

metadata - Any associated metadata about the translation string This parameter may be null

Returns:

a result object that contains an indicator of whether the operation succeeded and may contain a string of any warning or error message

getString

public java.lang.String getString(java.lang.String key)

Description copied from interface: ResourceBundleWrapper

Gets the translated text (value) identified by key

Specified by:

getString in interface ResourceBundleWrapper

Overrides:

getString in class ResourceBundleWrapperRT

Parameters:

key - The key in the resource bundle

Returns:

The translated text.

setParent

public void setParent(ResourceBundleWrapperRT parentBundle)

updateEntry

public boolean updateEntry(java.lang.String key,
                           java.lang.String text,
                           java.util.Map<java.lang.String,java.lang.String> metadata)

Description copied from interface: ResourceBundleWrapper

Updates the specified key to have the specified text and metadata. Shows a dialog to warn the user that a key is being updated (the dialog may be suppressed if it's "Don't show this again" checkbox has been checked.

Specified by:

updateEntry in interface ResourceBundleWrapper

Overrides:

updateEntry in class ResourceBundleWrapperRT

Parameters:

key - The key to update

text - The new text for the given key

metadata - Any metadata to change. Existing metadata is merged with the new metadata, unless there is a key with a null value, then the existing metadata for that key is removed. If metadata is null then the existing metadata will be unchanged.

Returns:

true on success

updateEntryNoDialog

public ResourceBundleOperationResult updateEntryNoDialog(java.lang.String key,
                                                         java.lang.String text,
                                                         java.util.Map<java.lang.String,java.lang.String> metadata)

Description copied from interface: ResourceBundleWrapper

Updates the specified key to have the specified text and metadata while not showing any dialog

Specified by:

updateEntryNoDialog in interface ResourceBundleWrapper

Overrides:

updateEntryNoDialog in class ResourceBundleWrapperRT

Parameters:

key - The key to update

text - The new text for the given key

metadata - Any metadata to change. Existing metadata is merged with the new metadata, unless there is a key with a null value, then the existing metadata for that key is removed. If metadata is null then the existing metadata will be unchanged.

Returns:

a result object that contains an indicator of whether the operation succeeded and may contain a string of any warning or error message

updateEntryNoDialog

public ResourceBundleOperationResult updateEntryNoDialog(java.lang.String key,
                                                         java.lang.String text,
                                                         java.util.Map<java.lang.String,java.lang.String> metadata,
                                                         CustomizationHint hint)

Overrides:

updateEntryNoDialog in class ResourceBundleWrapperRT

updateEntry

public boolean updateEntry(java.lang.String key,
                           java.lang.String text,
                           java.util.Map<java.lang.String,java.lang.String> note,
                           CustomizationHint hint)

Only for string editor use. update behavior Case I - entries coming from base classpath bundles- written to the tip layer of trimmed CC List Case II - entries coming from within the trimmed CC list - written to the tip layer of trimmed CC List Case III - entries coming from outside the trimmed CC list- written to the layer where the entry was found

Overrides:

updateEntry in class ResourceBundleWrapperRT

Parameters:

key - Key to be updated

text - String to be updated

note - Note to be updated

hint - CustomizationHint object keeping track of the CC layer where the update should go.

Returns:

true/false - true if the upadte was successful , false otherwise

updateEntry

protected boolean updateEntry(java.lang.String key,
                              java.lang.String text,
                              java.util.Map<java.lang.String,java.lang.String> metadata,
                              oracle.mds.core.MetadataObject metadataObject)

Only for string editor use. The overriden method in CompBundleCachedXliffResourceBundleWrapper will be called. For updating strings which came from outside of the trimmed CC list. Updated will be based on the passed in MetadataObject.

Overrides:

updateEntry in class ResourceBundleWrapperRT

Parameters:

key - Key to be updated

text - String to be updated

metadata - Note to be updated

metadataObject - MO where the update will go

Returns:

true/false - true if the upadte was successful , false otherwise

deleteEntry

public boolean deleteEntry(java.lang.String key)

Description copied from interface: ResourceBundleWrapper

Deletes the resource bundle entry identified by key. If key does not exist, then a value of false is returned.

Specified by:

deleteEntry in interface ResourceBundleWrapper

Overrides:

deleteEntry in class ResourceBundleWrapperRT

Parameters:

key - The key to delete

Returns:

true If the key is found and deleted success.

keySet

public java.util.Set<java.lang.String> keySet()

Description copied from interface: ResourceBundleWrapper

Returns a set view of the keys contained in this resource bundle. This method provides a "read-only" view of the keys in this resource bundle. Any attempts to modify this Set, directly or through its Iterator will throw an UnsupportedOperationException.

Returns:

A set view of the keys in this resource bundle

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata(java.lang.String key)

Description copied from interface: ResourceBundleWrapper

Gets the translated text (value) identified by key

Parameters:

key - The key in the resource bundle

Returns:

The metadata

getKeyValueMap

public java.util.Map<java.lang.String,java.lang.String> getKeyValueMap()

Description copied from class: ResourceBundleWrapperRT

Gets the map of key-values for this bundle. This map will not include keys from related bundles in the language hierarchy. For that call getChainedKeyValueMap() instead. For example, if bundleA is requested in the Locale.US then the related bundles would be bundleA_en_US, bundleA_en, bundleA

Specified by:

getKeyValueMap in class ResourceBundleWrapperRT

Returns:

map of key/values

setWritable

public void setWritable(boolean writable)

getMutableMO

protected oracle.mds.core.MetadataObject getMutableMO(oracle.mds.core.MDSSession mdsSession,
                                                      oracle.mds.core.MOReference moRef,
                                                      java.lang.String custLayerName,
                                                      java.lang.String custLayerValue)

parse

public void parse(java.net.URL url)

Specified by:

parse in class ResourceBundleWrapperRT

setDocument

public void setDocument(org.w3c.dom.Document document)

This should only be used when dealing with an override bundle and via the AppBundleInfoRT class

getDocument

protected org.w3c.dom.Document getDocument()

parse

public void parse(org.w3c.dom.Document document)

parse

public void parse(org.w3c.dom.Document document,
                  java.util.Map<java.lang.String,ResourceBundleWrapper.KeyInfo> keyMap,
                  java.util.Map<java.lang.String,java.lang.String> keyValueMap)

addMetadata

protected void addMetadata(org.w3c.dom.Element element,
                           java.util.Map<java.lang.String,java.lang.String> metadata)

updateDocument

public void updateDocument(org.w3c.dom.Document document)