oracle.javatools.resourcebundle.impl

Class CompBundleCachedXliffResourceBundleWrapper

java.lang.Object

oracle.javatools.resourcebundle.ResourceBundleWrapperRT

oracle.javatools.resourcebundle.impl.XliffResourceBundleWrapper

oracle.javatools.resourcebundle.impl.CompBundleCachedXliffResourceBundleWrapper

All Implemented Interfaces:

ResourceBundleWrapper, SearchSupport

public class CompBundleCachedXliffResourceBundleWrapper
extends XliffResourceBundleWrapper

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.resourcebundle.impl.XliffResourceBundleWrapper

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 inherited from class oracle.javatools.resourcebundle.impl.XliffResourceBundleWrapper

_writable

Fields inherited from class oracle.javatools.resourcebundle.ResourceBundleWrapperRT

_parent

Constructor Summary

Constructors

Constructor and Description
CompBundleCachedXliffResourceBundleWrapper()

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.
boolean	addEntry(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata, oracle.mds.cust.CustClassList custClassList) Add API to add a resourcebundle string to a target tip layer.
boolean	deleteEntry(java.lang.String key) Deletes the resource bundle entry identified by key.
boolean	deleteEntry(java.lang.String key, oracle.mds.cust.CustClassList custClassList) Delete API to delete a resourcebundle string from target tip layer.
boolean	deleteEntry(java.lang.String key, oracle.mds.core.MetadataObject metadataObject)
java.util.Map<java.lang.String,ResourceBundleWrapper.KeyInfo>	getBaseKeyMap()
java.util.Map<java.lang.String,ResourceBundleWrapper.KeyInfo>	getBaseKeyMap(oracle.mds.core.MetadataObject metadataObject)
protected java.util.Map<java.lang.String,java.lang.String>	getBaseKeyValueMap()
protected java.util.Map<java.lang.String,java.lang.String>	getBaseKeyValueMap(oracle.mds.core.MetadataObject metadataObject)
protected org.w3c.dom.Document	getDocument()
protected org.w3c.dom.Document	getDocument(oracle.mds.core.MetadataObject metadataObject)
void	parse(org.w3c.dom.Document document)
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
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> metadata, oracle.mds.cust.CustClassList custClassList) Update API to edit a resourcebundle string to a target tip layer.
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.
boolean	updateEntryExport(java.lang.String key, java.lang.String custHint, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> metadata, oracle.mds.core.MetadataObject metadataObject) Update API to export resourcebundle strings from MDS.
boolean	updateEntryImport(java.lang.String key, java.lang.String text, java.util.Map<java.lang.String,java.lang.String> note, CustomizationHint hint) Update API to import resourcebundle strings in MDS in terms of companion bundle and customizations.

Methods inherited from class oracle.javatools.resourcebundle.impl.XliffResourceBundleWrapper

addEntryNoDialog, addMetadata, createMOReference, getBundleIdentifier, getKeyValueMap, getMetadata, getMetadataObject, getMetadataObject, getMetadataObject, getMOKey, getMutableMO, getString, keySet, parse, saxParse, seParse, seParse, setParent, setWritable, updateDocument, updateEntry, updateEntryNoDialog, updateEntryNoDialog

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, isCacheable, isEmptyReadOnlyWrapper, isIsSEWrapper, refreshBundleIfNeeded, removeResourceBundleListener, setBundleId, setEmptyReadOnlyWrapper, setIsSEWrapper, setKeyGenerator, setParentList, setURL, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CompBundleCachedXliffResourceBundleWrapper

public CompBundleCachedXliffResourceBundleWrapper()

Method Detail

addEntry

public boolean addEntry(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:

addEntry in interface ResourceBundleWrapper

Overrides:

addEntry in class XliffResourceBundleWrapper

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

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 XliffResourceBundleWrapper

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

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 XliffResourceBundleWrapper

Parameters:

key - The key to delete

Returns:

true If the key is found and deleted success.

updateEntry

public boolean updateEntry(java.lang.String key,
                           java.lang.String text,
                           java.util.Map<java.lang.String,java.lang.String> metadata,
                           oracle.mds.cust.CustClassList custClassList)

Description copied from class: ResourceBundleWrapperRT

Update API to edit a resourcebundle string to a target tip layer. The tip layer information is passed as part of CustClassList.

Overrides:

updateEntry in class ResourceBundleWrapperRT

Parameters:

key - The key to update

text - The text to update

metadata - The Note to update

custClassList - The tip layer where the customization will be written to

Returns:

true/false , true if update operation succeeds, false otherwise

addEntry

public boolean addEntry(java.lang.String key,
                        java.lang.String text,
                        java.util.Map<java.lang.String,java.lang.String> metadata,
                        oracle.mds.cust.CustClassList custClassList)

Description copied from class: ResourceBundleWrapperRT

Add API to add a resourcebundle string to a target tip layer. The tip layer information is passed as part of CustClassList.

Overrides:

addEntry in class ResourceBundleWrapperRT

Parameters:

key - The key to add

text - The text to add

metadata - The Note to add

custClassList - The tip layer where the customization will be written to

Returns:

true/false , true if add operation succeeds, false otherwise

deleteEntry

public boolean deleteEntry(java.lang.String key,
                           oracle.mds.cust.CustClassList custClassList)

Description copied from class: ResourceBundleWrapperRT

Delete API to delete a resourcebundle string from target tip layer. The tip layer information is passed as part of CustClassList.

Overrides:

deleteEntry in class ResourceBundleWrapperRT

Parameters:

key - The key to delete

custClassList - The tip layer where the customization will be written to

Returns:

true/false , true if delete operation succeeds, false otherwise

getBaseKeyMap

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

Overrides:

getBaseKeyMap in class XliffResourceBundleWrapper

getBaseKeyValueMap

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

Overrides:

getBaseKeyValueMap in class XliffResourceBundleWrapper

getBaseKeyValueMap

protected java.util.Map<java.lang.String,java.lang.String> getBaseKeyValueMap(oracle.mds.core.MetadataObject metadataObject)

getBaseKeyMap

public java.util.Map<java.lang.String,ResourceBundleWrapper.KeyInfo> getBaseKeyMap(oracle.mds.core.MetadataObject metadataObject)

setDocument

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

Description copied from class: XliffResourceBundleWrapper

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

Overrides:

setDocument in class XliffResourceBundleWrapper

getDocument

protected org.w3c.dom.Document getDocument()

Overrides:

getDocument in class XliffResourceBundleWrapper

parse

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

Overrides:

parse in class XliffResourceBundleWrapper

parse

public void parse(java.net.URL url)

Overrides:

parse in class XliffResourceBundleWrapper

updateEntryExport

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

Update API to export resourcebundle strings from MDS.

Overrides:

updateEntryExport in class ResourceBundleWrapperRT

Parameters:

key - Trans-unit Key

custHint - String representation of CustomizationHint object conatining cust informations

text - Trans-unit source string

metadata - Trans-unit note map

metadataObject - MO object

Returns:

true if update success , 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 XliffResourceBundleWrapper

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,
                           oracle.mds.core.MetadataObject metadataObject)

getDocument

protected org.w3c.dom.Document getDocument(oracle.mds.core.MetadataObject metadataObject)

updateEntryImport

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

Update API to import resourcebundle strings in MDS in terms of companion bundle and customizations.

Overrides:

updateEntryImport in class ResourceBundleWrapperRT

Parameters:

key - Trans-unit Key

text - Trans-unit source string

note - Trans-unit note map

hint - Customization Hint

Returns:

true if update success , false otherwise