();
+ // names.putAll(LoadWebServerExtenderNames());
String keys[] = Configuration.GetServerSubpropertiesThatAreBranches(SAGEX_CONTEXTS);
if (keys != null) {
- for (String k: keys) {
+ for (String k : keys) {
String name = Configuration.GetServerProperty(getContextKeyName(k), null);
if (!StringUtils.isEmpty(name)) {
names.put(k, name);
diff --git a/src/main/java/phoenix/impl/CommercialAPI.java b/src/main/java/phoenix/impl/CommercialAPI.java
index 7c46972..73b0a13 100644
--- a/src/main/java/phoenix/impl/CommercialAPI.java
+++ b/src/main/java/phoenix/impl/CommercialAPI.java
@@ -17,6 +17,7 @@
/**
* API for reading EDL Files for commercial skip. An EDL file has the following
* Structure...
+ *
*
* 83.78 299.27 0
* 832.90 1018.22 0
@@ -29,79 +30,92 @@
* @author seans
*
*/
-@API(group="comskip")
+@API(group = "comskip")
public class CommercialAPI {
- private Logger log = Logger.getLogger(CommercialAPI.class);
-
- /**
- * For the given medai file, return the .edl file
- *
- * @param mediaFile Sage MediaFile or VFS MediaFile
- * @return {@link File} representing the .edl file. It may not exist.
- */
- public File GetCommercialFile(Object mediaFile) {
- File seg = phoenix.media.GetFileSystemMediaFile(mediaFile);
- if (seg==null) return null;
- return new File(seg.getParentFile(), FilenameUtils.getBaseName(seg.getName()) + ".edl");
- }
+ private Logger log = Logger.getLogger(CommercialAPI.class);
+
+ /**
+ * For the given medai file, return the .edl file
+ *
+ * @param mediaFile
+ * Sage MediaFile or VFS MediaFile
+ * @return {@link File} representing the .edl file. It may not exist.
+ */
+ public File GetCommercialFile(Object mediaFile) {
+ File seg = phoenix.media.GetFileSystemMediaFile(mediaFile);
+ if (seg == null)
+ return null;
+ return new File(seg.getParentFile(), FilenameUtils.getBaseName(seg.getName()) + ".edl");
+ }
+
+ /**
+ * Return true if an edl file file exists, AND it has some content
+ *
+ * @param mediaFile
+ * Sage MediaFile or VFS MediaFile
+ * @return true if the file exists and has content
+ */
+ public boolean HasCommercials(Object mediaFile) {
+ File f = GetCommercialFile(mediaFile);
+ return f != null && f.exists() && f.length() > 0;
+ }
+
+ /**
+ * Return the Commercial start and stop points as an Array of
+ * {@link CommercialStruct} items
+ *
+ * @param mediaFile
+ * Sage MediaFile or VFS MediaFile
+ * @return Array of {@link CommercialStruct} items or null if there are no
+ * commercials
+ */
+ public CommercialStruct[] getCommercials(Object mediaFile) {
+ List comms = new ArrayList();
+ try {
+ Pattern commPat = Pattern.compile("([0-9\\.]+)\\s+([0-9\\.]+)");
+ LineIterator iter = FileUtils.lineIterator(GetCommercialFile(mediaFile));
+ while (iter.hasNext()) {
+ String line = iter.nextLine();
+ Matcher m = commPat.matcher(line);
+ if (m.find()) {
+ CommercialStruct cs = new CommercialStruct();
+ cs.start = NumberUtils.toFloat(m.group(1), 0f);
+ cs.stop = NumberUtils.toFloat(m.group(2), 0f);
+ comms.add(cs);
+ }
+ }
+ } catch (Exception e) {
+ log.warn("Failed to process commercials for: " + mediaFile, e);
+ }
- /**
- * Return true if an edl file file exists, AND it has some content
- * @param mediaFile Sage MediaFile or VFS MediaFile
- * @return true if the file exists and has content
- */
- public boolean HasCommercials(Object mediaFile) {
- File f = GetCommercialFile(mediaFile);
- return f!=null && f.exists() && f.length()>0;
- }
+ if (comms.isEmpty())
+ return null;
+ return comms.toArray(new CommercialStruct[] {});
+ }
- /**
- * Return the Commercial start and stop points as an Array of {@link CommercialStruct} items
- *
- * @param mediaFile Sage MediaFile or VFS MediaFile
- * @return Array of {@link CommercialStruct} items or null if there are no commercials
- */
- public CommercialStruct[] getCommercials(Object mediaFile) {
- List comms = new ArrayList();
- try {
- Pattern commPat = Pattern.compile("([0-9\\.]+)\\s+([0-9\\.]+)");
- LineIterator iter = FileUtils.lineIterator(GetCommercialFile(mediaFile));
- while (iter.hasNext()) {
- String line = iter.nextLine();
- Matcher m = commPat.matcher(line);
- if (m.find()) {
- CommercialStruct cs = new CommercialStruct();
- cs.start = NumberUtils.toFloat(m.group(1), 0f);
- cs.stop = NumberUtils.toFloat(m.group(2), 0f);
- comms.add(cs);
- }
- }
- } catch (Exception e) {
- log.warn("Failed to process commercials for: " + mediaFile, e);
- }
-
- if (comms.isEmpty()) return null;
- return comms.toArray(new CommercialStruct[] {});
- }
-
- /**
- * return the start value for the commercial
- * @param comm {@link CommercialStruct}
- * @return start value
- */
- public float getCommercialStart(CommercialStruct comm) {
- if (comm==null) return 0f;
- return comm.start;
- }
+ /**
+ * return the start value for the commercial
+ *
+ * @param comm
+ * {@link CommercialStruct}
+ * @return start value
+ */
+ public float getCommercialStart(CommercialStruct comm) {
+ if (comm == null)
+ return 0f;
+ return comm.start;
+ }
- /**
- * return the stop value for the commercial
- *
- * @param comm {@link CommercialStruct}
- * @return stop value
- */
- public float getCommercialStop(CommercialStruct comm) {
- if (comm==null) return 0f;
- return comm.stop;
- }
+ /**
+ * return the stop value for the commercial
+ *
+ * @param comm
+ * {@link CommercialStruct}
+ * @return stop value
+ */
+ public float getCommercialStop(CommercialStruct comm) {
+ if (comm == null)
+ return 0f;
+ return comm.stop;
+ }
}
diff --git a/src/main/java/phoenix/impl/CommercialStruct.java b/src/main/java/phoenix/impl/CommercialStruct.java
index 30f1c71..7c0d080 100644
--- a/src/main/java/phoenix/impl/CommercialStruct.java
+++ b/src/main/java/phoenix/impl/CommercialStruct.java
@@ -2,9 +2,10 @@
/**
* Simple structure for holding a single commercial data
+ *
* @author seans
*/
public class CommercialStruct {
- public float start;
- public float stop;
+ public float start;
+ public float stop;
}
\ No newline at end of file
diff --git a/src/main/java/phoenix/impl/ConfigurableOptionsAPI.java b/src/main/java/phoenix/impl/ConfigurableOptionsAPI.java
index da6772e..e6db4fd 100644
--- a/src/main/java/phoenix/impl/ConfigurableOptionsAPI.java
+++ b/src/main/java/phoenix/impl/ConfigurableOptionsAPI.java
@@ -13,8 +13,9 @@
import sagex.phoenix.tools.annotation.API;
/**
- * API for managing configurable options that tend to be used in Factories and Views
- *
+ * API for managing configurable options that tend to be used in Factories and
+ * Views
+ *
* @author seans
*/
@API(group = "opt")
@@ -22,15 +23,15 @@ public class ConfigurableOptionsAPI {
public String GetName(ConfigurableOption opt) {
return opt.getName();
}
-
+
public String GetLabel(ConfigurableOption opt) {
return opt.getLabel();
}
-
+
public String GetType(ConfigurableOption opt) {
return opt.getDataType().name();
}
-
+
public String GetValue(ConfigurableOption opt) {
return opt.getString("");
}
@@ -54,27 +55,28 @@ public void SetValue(ConfigurableOption opt, String value) {
public boolean IsList(ConfigurableOption opt) {
return opt.isList();
}
-
+
public boolean IsMultiSelectList(ConfigurableOption opt) {
return IsList(opt) && ListSelection.multi.equals(opt.getListSelection());
}
-
+
public List GetListValues(ConfigurableOption opt) {
return opt.getListValues();
}
-
+
public String GetName(ListValue listValue) {
return listValue.getName();
}
-
+
public String GetValue(ListValue listValue) {
return listValue.getValue();
}
-
+
public boolean IsToggle(ConfigurableOption opt) {
- return DataType.bool.equals(opt.getDataType()) || (IsList(opt) && opt.getListValues()!=null&&opt.getListValues().size()>=2);
+ return DataType.bool.equals(opt.getDataType())
+ || (IsList(opt) && opt.getListValues() != null && opt.getListValues().size() >= 2);
}
-
+
public void Toggle(ConfigurableOption opt) {
if (IsToggle(opt)) {
if (DataType.bool.equals(opt.getDataType())) {
@@ -82,42 +84,44 @@ public void Toggle(ConfigurableOption opt) {
opt.value().setValue(String.valueOf(!opt.getBoolean(true)));
return;
}
-
+
// otherwise toggle list
List values = opt.getListValues();
String curVal = opt.getString("");
- if (curVal==null) {
+ if (curVal == null) {
opt.value().setValue(values.get(0).getValue());
return;
}
-
+
// otherwise, find our option, and then move to the next one
int pos = -1;
- for (int i=0;i=values.size()) {
- pos=0;
+ if (pos >= values.size()) {
+ pos = 0;
}
opt.value().setValue(values.get(pos).getValue());
}
}
-
+
public boolean IsListItemSelected(ConfigurableOption opt, ListValue item) {
Object val = opt.value().get();
- if (val==null) return false;
+ if (val == null)
+ return false;
String vals[] = String.valueOf(val).split("\\s*,\\s*");
-
- for (String s: vals) {
- if (s.equals(item.getValue())) return true;
+
+ for (String s : vals) {
+ if (s.equals(item.getValue()))
+ return true;
}
-
+
return false;
}
@@ -126,12 +130,14 @@ public void SelectItem(ConfigurableOption opt, ListValue item) {
if (opt.isList() && ListSelection.single.equals(opt.getListSelection())) {
opt.value().setValue(item.getValue());
}
-
+
// multi-select, then add this selection
Object val = opt.value().get();
- if (val==null) return;
+ if (val == null)
+ return;
List vals = new ArrayList(Arrays.asList(String.valueOf(val).split("\\s*,\\s*")));
- if (vals.contains(item.getValue())) return;
+ if (vals.contains(item.getValue()))
+ return;
vals.add(item.getValue());
opt.value().setValue(StringUtils.join(vals, ","));
}
@@ -141,15 +147,16 @@ public void UnselectItem(ConfigurableOption opt, ListValue item) {
if (opt.isList() && ListSelection.single.equals(opt.getListSelection())) {
opt.value().setValue(null);
}
-
+
// multi-select, then add this selection
Object val = opt.value().get();
- if (val==null) return;
+ if (val == null)
+ return;
List vals = new ArrayList(Arrays.asList(String.valueOf(val).split("\\s*,\\s*")));
vals.remove(item.getValue());
opt.value().setValue(StringUtils.join(vals, ","));
}
-
+
public ListValue GetSelectedItem(ConfigurableOption opt) {
for (ListValue lv : opt.getListValues()) {
if (IsListItemSelected(opt, lv)) {
@@ -158,5 +165,5 @@ public ListValue GetSelectedItem(ConfigurableOption opt) {
}
return null;
}
-
+
}
diff --git a/src/main/java/phoenix/impl/ConfigurationAPI.java b/src/main/java/phoenix/impl/ConfigurationAPI.java
index d37293b..14c7159 100644
--- a/src/main/java/phoenix/impl/ConfigurationAPI.java
+++ b/src/main/java/phoenix/impl/ConfigurationAPI.java
@@ -19,731 +19,779 @@
* STV Api Calls related to the Configuration API
*
* @author seans
- *
+ *
*/
-@API(group="config")
+@API(group = "config")
public class ConfigurationAPI {
- /**
- * Returns the Configured Property value for the client scope, or a default value, if the
- * property is not set.
- *
- * @param key
- * Configuration Key of the property
- * @param defValue
- * Default Value to use if the property is not set.
- * @return property value if it is set, or defValue if it is not set
- * @throws RuntimeException
- * if a property key is not configured and strict mode is enabled
- */
- public String GetProperty(String key, Object defValue) {
- return Phoenix.getInstance().getConfigurationManager().getClientProperty(key, (defValue==null)?null:String.valueOf(defValue));
- }
-
- /**
- * Same as calling GetProperty(key, null)
- *
- * @param key
- * property key or {@link IConfigurationElement}
- * @return property value
- */
- public String GetProperty(Object key) {
- if (key instanceof IConfigurationElement) {
- return GetProperty(((IConfigurationElement)key).getId(), null);
- } else {
- return GetProperty(String.valueOf(key),null);
- }
- }
-
- /**
- * Returns the Configured Property value for the server's scope, or a default value, if the
- * property is not set.
- *
- * @param key
- * Configuration Key of the property
- * @param defValue
- * Default Value to use if the property is not set.
- * @return property value if it is set, or defValue if it is not set
- * @throws RuntimeException
- * if a property key is not configured and strict mode is enabled
- */
- public String GetServerProperty(String key, Object defValue) {
- return Phoenix.getInstance().getConfigurationManager().getServerProperty(key, (defValue==null)?null:String.valueOf(defValue));
- }
-
- /**
- * Same as calling GetProperty(key, null)
- *
- * @param key
- * property key or {@link IConfigurationElement}
- * @return property value
- */
- public String GetServerProperty(Object key) {
- if (key instanceof IConfigurationElement) {
- return GetServerProperty(((IConfigurationElement)key).getId(),null);
- } else {
- return GetServerProperty(String.valueOf(key),null);
- }
- }
-
- /**
- * Returns the Configured Property value for the users's scope, or a default value, if the
- * property is not set.
- *
- * @param key
- * Configuration Key of the property
- * @param defValue
- * Default Value to use if the property is not set.
- * @return property value if it is set, or defValue if it is not set
- * @throws RuntimeException
- * if a property key is not configured and strict mode is enabled
- */
- public String GetUserProperty(String key, Object defValue) {
- if (defValue == null) {
- return Phoenix.getInstance().getConfigurationManager().getUserProperty(key, null);
- } else {
- return Phoenix.getInstance().getConfigurationManager().getUserProperty(key, String.valueOf(defValue));
- }
- }
-
- /**
- * Same as calling GetProperty(key, null)
- *
- * @param key
- * property key or {@link IConfigurationElement}
- * @return property value
- */
- public String GetUserProperty(Object key) {
- if (key instanceof IConfigurationElement) {
- return GetUserProperty(((IConfigurationElement)key).getId(),null);
- } else {
- return GetUserProperty(String.valueOf(key),null);
- }
- }
-
- /**
- * Sets the given property key to the given value for the client scope
- *
- * Setting a null property value will unset a property
- *
- * @param key
- * property key or {@link IConfigurationElement}
- * @param value
- * property value
- */
- public void SetProperty(Object key, Object value) {
- if (key instanceof IConfigurationElement) {
- Phoenix.getInstance().getConfigurationManager().setProperty(((IConfigurationElement)key).getId(), (value==null)?null:String.valueOf(value));
- } else {
- Phoenix.getInstance().getConfigurationManager().setProperty(String.valueOf(key), (value==null)?null:String.valueOf(value));
- }
- }
-
- /**
- * Sets the given property key to the given value for the server scope
- *
- * Setting a null property value will unset a property
- *
- * @param key
- * property key or {@link IConfigurationElement}
- * @param value
- * property value
- */
- public void SetServerProperty(Object key, Object value) {
- if (key instanceof IConfigurationElement) {
- Phoenix.getInstance().getConfigurationManager().setServerProperty(((IConfigurationElement)key).getId(), (value==null)?null:String.valueOf(value));
- } else {
- Phoenix.getInstance().getConfigurationManager().setServerProperty(String.valueOf(key), (value==null)?null:String.valueOf(value));
- }
- }
-
- /**
- * Sets the given property key to the given value for the user scope
- *
- * Setting a null property value will unset a property
- *
- * @param key
- * property key or {@link IConfigurationElement}
- * @param value
- * property value
- */
- public void SetUserProperty(Object key, Object value) {
- if (key instanceof IConfigurationElement) {
- Phoenix.getInstance().getConfigurationManager().setUserProperty(((IConfigurationElement)key).getId(), (value==null)?null:String.valueOf(value));
- } else {
- Phoenix.getInstance().getConfigurationManager().setUserProperty(String.valueOf(key), (value==null)?null:String.valueOf(value));
- }
- }
-
- /**
- * Returns the Top level Configuration Groups. Think of Configuration Groups
- * like a Folder Structure. The method call always returns the Groups of the
- * root node.
- *
- * @return Array of IConconfigureElement nodes
- */
- public IConfigurationElement[] GetConfigurationGroups() {
- return Phoenix.getInstance().getConfigurationMetadataManager().getParentGroups();
- }
-
- /**
- * Returns the top level configuration group. This group contains the
- * configurated application groups in the configuration metadata system.
- *
- * @return {@link Group} Root Configuration Group
- */
- public Group GetConfigurationRoot() {
- return Phoenix.getInstance().getConfigurationMetadataManager().getMetadata();
- }
-
- /**
- * Returns the Configuration Group for the given group id
- *
- * @param groupId
- * Group Id for the configuration
- * @return {@link Group} or null if there is no group.
- */
- public Group GetConfiguration(String groupId) {
- return (Group) GetConfigurationRoot().findElement(groupId);
- }
-
- /**
- * Returns the configuration metadata for the given property key or fieldId
- *
- * @param fieldId field's id (ie, property name)
- * @return Field
- */
- public Field GetField(String fieldId) {
- return (Field) GetConfigurationRoot().findElement(fieldId);
- }
-
- /**
- * return the {@link IConfigurationElement} for the given key. ie, this may return
- * a {@link Group} or a {@link Field}.
- *
- * @param key
- * @return
- */
- public IConfigurationElement GetElement(String key) {
- return GetConfigurationRoot().findElement(key);
- }
-
- /**
- * Returns the Parent Group to which this element belongs, or null, if there
- * is no parent.
- *
- * @param el
- * {@link IConfigurationElement} configuration element (field or
- * group)
- * @return parent {@link Group} or null if there is no parent.
- */
- public Group GetConfigurationParent(IConfigurationElement el) {
- if (el == null) return null;
- return (Group) el.getParent();
- }
-
- /**
- * Get all Configuration Elements of the given group. A Configuration
- * Element can either be a Group or Field.
- *
- * @param parent
- * Parent Group from which you want to get the Configuration
- * Elements
- * @return Array of IConfigurationElement nodes, or null if there are no
- * children, or if the parent is null
- */
- public IConfigurationElement[] GetConfigurationChildren(Group parent) {
- if (parent == null) {
- return null;
- }
- return parent.getVisibleItems();
- }
-
- /**
- * Returns true of the element is a Group Element. You can think of Group
- * elements like Folders. Group Elements contain Children that can either be
- * another Group or a Field
- *
- * @param e
- * IConfigurationElement that you want to test
- * @return true if the element is a Group
- */
- public boolean IsConfigurationGroup(IConfigurationElement e) {
- if (e == null) return false;
- return e.getElementType() == IConfigurationElement.GROUP || e.getElementType() == IConfigurationElement.APPLICATION;
- }
-
- /**
- * Returns true if the Configuration Element is a top level application
- * element. Application Elements are Also Group Elements, but they are a
- * special type of Group. Application Elements are basically the parent of a
- * collection of related groups. ie, "sage" would be an Application Element
- * that contains all the configuration items for SageTV. "phoenix" would be
- * an Application Element that contains all the configuration items for
- * Phoenix.
- *
- * @param e
- * IConfigurationElement that you are testing
- * @return true if this element is an Application Element
- */
- public boolean IsConfigurationApplication(IConfigurationElement e) {
- if (e == null) return false;
- return e.getElementType() == IConfigurationElement.APPLICATION;
- }
-
- /**
- * Returns true if this element is a Configuration Field. A Configuration
- * Field is a child of a Group and contains information about the
- * configurable item. It holds information such as it's default value, field
- * type, configuration key, etc.
- *
- * @param e
- * {@link IConfigurationElement} that you are testing
- * @return true if this element is a Field
- */
- public boolean IsConfigurationField(IConfigurationElement e) {
- if (e == null) return false;
- return e.getElementType() == IConfigurationElement.FIELD;
- }
-
- /**
- * Returns the localized Label for the Configuration Element. This can be an
- * Application, Group, of Field.
- *
- * @param g
- * Configuration Element from which you want to get a Localized
- * Label
- * @return Localized label for the given Configuration Element
- */
- public String GetConfigurationLabel(IConfigurationElement g) {
- if (g == null) return "";
- return g.getLabel();
- }
-
- /**
- * Returns the localized Description for the Configuration Element. This can
- * be an Application, Group, of Field.
- *
- * @param g
- * Configuration Element from which you want to get a Localized
- * Description
- * @return Localized description for the given Configuration Element
- */
- public String GetConfigurationDescription(IConfigurationElement g) {
- if (g == null) return "";
- return g.getDescription();
- }
-
- /**
- * Returns the configuration element type as defined in {@link ConfigType}
- *
- * @param e
- * {@link IConfigurationElement}
- * @return field's type as a string value
- */
- public String GetConfigurationFieldType(IConfigurationElement e) {
- if (e == null) return ConfigType.toCommonName(ConfigType.TEXT);
- return ConfigType.toCommonName(((Field) e).getType());
- }
-
- /**
- * Returns the field's default value as a String. A field's default value is
- * determined from the defaultValue attribute of the field in the
- * configuration metadata xml
- *
- * @param e
- * {@link IConfigurationElement}
- * @return default value of the element as a String
- */
- public String GetConfigurationDefaultValue(IConfigurationElement e) {
- if (e == null) return "";
- return ((Field) e).getDefaultValue();
- }
-
- /**
- * Return the unique key that identifies this Configuration Field. This is
- * the key that this Field uses in it's property file. All
- * {@link IConfigurationElement}'s must be unique the system.
- *
- * @param e
- * {@link IConfigurationElement}
- * @return Key for this Element
- */
- public String GetConfigurationKey(IConfigurationElement e) {
- if (e == null) return "";
- return e.getId();
- }
-
- /**
- * This is a debug method that can be used to reload the configuration and
- * configuration metadata without requiring a complete SageTV restart. The
- * main use for this would be when you are developing in the STV and you
- * need a new property, you can edit the metadata xml and then reload the
- * configuration so that you can carry forward and use that new
- * configuration item without have to restart SageTV.
- *
- * This API call will probably be hidden once the project is released.
- */
- public void ReloadConfiguration() {
- Phoenix.getInstance().getConfigurationMetadataManager().loadConfigurations();
- Phoenix.getInstance().getConfigurationManager().reload();
- }
-
- /**
- * Convenience Method for testing if a Configuration Item is the "New Search" group item.
- *
- * @param el {@link IConfigurationElement}
- * @return true if the item is the "New Search" configuration group item
- */
- public boolean IsConfigurationNewSearchButton(IConfigurationElement el) {
- return el instanceof NewSearchGroup;
- }
-
- /**
- * Convenience Method for testing if a Configuration Item is a Search Results group item.
- *
- * @param el {@link IConfigurationElement}
- * @return true if the item is a search result group
- */
- public boolean IsConfigurationSearchResult(IConfigurationElement el) {
- return el instanceof SearchResultGroup;
- }
-
- /**
- * Sets/Re-Sets the Search Criteria for a SearchResult Group
- *
- * @param text Search Criteria
- * @param el {@link IConfigurationElement}
- */
- public void UpdateConfigurationSearch(String text, IConfigurationElement el) {
- if (IsConfigurationSearchResult(el)) {
- ((SearchResultGroup)el).setSearchString(text);
- }
- }
-
- /**
- * Add a New Search Result to the Search parent
- *
- * @param searchCriteria What to search on
- * @return SearchResultGroup containing the item results
- */
- public Group AddConfigurationSearch(String searchCriteria) {
- return NewSearchGroup.newSearch(searchCriteria);
- }
-
- /**
- * Remove a Search Result Group from the Search Tab
- *
- * @param result {@link IConfigurationElement}
- */
- public void RemoveConfigurationSearch(IConfigurationElement el) {
- NewSearchGroup.removeSearch((SearchResultGroup)el);
- }
-
- /**
- * Return true if the configuration group has children
- *
- * @param group
- * @return
- */
- public boolean HasConfigurationChildren(IConfigurationElement group) {
- if (group == null) {
- return false;
- }
-
- if (group instanceof Group) {
- IConfigurationElement children[] = GetConfigurationChildren((Group)group);
- return children!=null && children.length>0;
- } else {
- return false;
- }
- }
-
- /**
- * Returns true if the configuration element is a boolean type
- *
- * @param el
- * @return
- */
- public boolean IsBoolean(IConfigurationElement el) {
- return IsType(el, ConfigType.BOOL.name());
- }
-
- /**
- * Return true if the configuration element is a number (ie, int, float, etc)
- * @param el
- * @return
- */
- public boolean IsNumber(IConfigurationElement el) {
- return IsType(el, ConfigType.NUMBER.name());
- }
-
- /**
- * Returns true if the configuration element is text or string
- *
- * @param el
- * @return
- */
- public boolean IsText(IConfigurationElement el) {
- return IsType(el, ConfigType.TEXT.name());
- }
-
- /**
- * Returns true if the configuration element is a Button.
- *
- * @param el
- * @return
- */
- public boolean IsButton(IConfigurationElement el) {
- return IsType(el, ConfigType.BUTTON.name());
- }
-
- /**
- * Returns true if the configuration is a single choice element. You can
- * call GetOptions(el) to get a list of possible options.
- *
- * @param el
- * @return
- */
- public boolean IsChoice(IConfigurationElement el) {
- return IsType(el, ConfigType.CHOICE.name());
- }
-
- /**
- * Returns true if the configuration element is a directory
- * @param el
- * @return
- */
- public boolean IsDirectory(IConfigurationElement el) {
- return IsType(el, ConfigType.DIRECTORY.name());
- }
-
- /**
- * Returns true if the configuration element is a regular file
- *
- * @param el
- * @return
- */
- public boolean IsFile(IConfigurationElement el) {
- return IsType(el, ConfigType.FILE.name());
- }
-
- /**
- * Returns true if the configuration element is a MultiChoice or Multi Select option. You
- * can call GetOption(el) to get a list of possible multi choice options.
- *
- * @param el
- * @return
- */
- public boolean IsMultiChoice(IConfigurationElement el) {
- return IsType(el, ConfigType.MULTICHOICE.name());
- }
-
- /**
- * Returns true if the type is a password. Password fields should be masked out and are stored as Text.
- *
- * @param el
- * @return
- */
- public boolean IsPassword(IConfigurationElement el) {
- return IsType(el, ConfigType.PASSWORD.name());
- }
-
- /**
- * Generic type check method that relies on the {@link ConfigType} for possible types.
- *
- * @param el
- * @param type
- * @return
- */
- public boolean IsType(IConfigurationElement el, String type) {
- ConfigType t = ConfigType.toConfigType(type);
- return (el!=null && el instanceof Field && t == ((Field)el).getType());
- }
-
- /**
- * For MultiChoice type fields, this is the list separator that should be used when storing multiple selections.
- *
- * @param f
- * @return
- */
- public String GetListSeparator(Field f) {
- return f.getListSeparator();
- }
-
- /**
- * Returns true if the configuration field has possible selection options. For boolean types this will also
- * return true, and you will have 2 possible options for "true" and "false".
- *
- * @param f
- * @return
- */
- public boolean HasOptions(Field f) {
- List opts = GetOptions(f);
- return opts!=null&&opts.size()>0;
- }
-
- /**
- * Returns the Options for a given field. May be null or empty. For booleans this will also return list
- * of 2 items for "true" and "false"
- *
- * @param f
- * @return
- */
- public List GetOptions(Field f) {
- return f.getOptions();
- }
-
- /**
- * For a given {@link NamedValue} option return the option's label.
- * @param option
- * @return
- */
- public String GetOptionLabel(NamedValue option) {
- return option.getName();
- }
-
- /**
- * For a given {@link NamedValue} option return the option's value.
- *
- * @param option
- * @return
- */
- public String GetOptionValue(NamedValue option) {
- return option.getValue();
- }
-
- /**
- * A convenience method to lookup an option's Label for a given value. For example, you can find the
- * label for a boolean field using GetOptionLable(field, "true", "OK").
- *
- * @param field Configuration {@link Field}
- * @param value option value
- * @param defLabel default label to return if the option's label is null, or the option does not exist.
- * @return
- */
- public String GetOptionLabel(Field field, Object value, String defLabel) {
- value = (value==null)?null:String.valueOf(value);
- List opts = field.getOptions();
- if (opts!=null) {
- for (NamedValue nv : opts) {
- if (value.equals(nv.getValue())) {
- return nv.getName();
- }
- }
- }
- return defLabel;
- }
-
- /**
- * Gets the {@link NamedValue} for the given value
- *
- * @param field
- * @param value
- * @return
- */
- public NamedValue GetOption(Field field, Object value) {
- value = (value==null)?null:String.valueOf(value);
- List opts = field.getOptions();
- if (opts!=null) {
- for (NamedValue nv : opts) {
- if (value.equals(nv.getValue())) {
- return nv;
- }
- }
- }
- return null;
- }
-
- /**
- * Returns the range of options for the given field, or null, if no options
- * are provided.
- *
- * @param field
- * @return
- */
- public String[] GetOptionRange(Field field) {
- List opts = field.getOptions();
- if (opts!=null&&opts.size()>0) {
- return new String[] {opts.get(0).getValue(), opts.get(opts.size()-1).getValue()};
- }
- return null;
- }
-
- /**
- * Returns true the the option's value is in the field's curValue list. ie, The option is
- * selected because the field's current value is the same as the option. This should work for both
- * Single Choice and Multi Choice options. For example, if the fields's current value is "12;24"
- * @param field
- * @param curValue
- * @param option
- * @return
- */
- public boolean IsSelected(NamedValue option, Field field, Object curValue) {
- if (curValue==null||field==null||option==null) return false;
- curValue = String.valueOf(curValue);
- String values[] = null;
- if (IsMultiChoice(field)) {
- values = ((String)curValue).split(field.getListSeparator());
- } else {
- values = new String[] {(String)curValue};
- }
- for (String v: values) {
- if (v.equals(option.getValue())) {
- return true;
- }
- }
- return false;
- }
-
- /**
- * Returns a List of NamedValue object, that can be used as configuration option
- * choices. The data can be a list, map, array, etc, and it will convert to
- * the List of NamedValue objects.
- *
- * @param data
- * @return
- */
- public List CreateOptionList(Object data) {
- return ConfigUtils.getOptions(data);
- }
-
- /**
- * Same as Toggle(Field) except uses the property Key.
- *
- * @param prop
- */
- public void Toggle(String prop) {
- Toggle(GetField(prop));
- }
-
- /**
- * For a boolean field it will toggle between true and false. For Choice options, it will
- * toggle to next value in the choice. ie, if the choices are "1", "2", and "3", then calling
- * Toggle when the value is "2" will set the value to "3", and calling Toggle when
- * the value is "3" will set the value to "1".
- *
- * If field can't be toggled then nothing happens.
- *
- * @param f Field to toggle
- */
- public void Toggle(Field f) {
- if (f.getType()==ConfigType.BOOL) {
- SetProperty(f, !BooleanUtils.toBoolean(GetProperty(f)));
- } else if (HasOptions(f)) {
- String value = GetProperty(f);
- List opts = f.getOptions();
- int pos = -1;
- for (int i=0;i 0;
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Returns true if the configuration element is a boolean type
+ *
+ * @param el
+ * @return
+ */
+ public boolean IsBoolean(IConfigurationElement el) {
+ return IsType(el, ConfigType.BOOL.name());
+ }
+
+ /**
+ * Return true if the configuration element is a number (ie, int, float,
+ * etc)
+ *
+ * @param el
+ * @return
+ */
+ public boolean IsNumber(IConfigurationElement el) {
+ return IsType(el, ConfigType.NUMBER.name());
+ }
+
+ /**
+ * Returns true if the configuration element is text or string
+ *
+ * @param el
+ * @return
+ */
+ public boolean IsText(IConfigurationElement el) {
+ return IsType(el, ConfigType.TEXT.name());
+ }
+
+ /**
+ * Returns true if the configuration element is a Button.
+ *
+ * @param el
+ * @return
+ */
+ public boolean IsButton(IConfigurationElement el) {
+ return IsType(el, ConfigType.BUTTON.name());
+ }
+
+ /**
+ * Returns true if the configuration is a single choice element. You can
+ * call GetOptions(el) to get a list of possible options.
+ *
+ * @param el
+ * @return
+ */
+ public boolean IsChoice(IConfigurationElement el) {
+ return IsType(el, ConfigType.CHOICE.name());
+ }
+
+ /**
+ * Returns true if the configuration element is a directory
+ *
+ * @param el
+ * @return
+ */
+ public boolean IsDirectory(IConfigurationElement el) {
+ return IsType(el, ConfigType.DIRECTORY.name());
+ }
+
+ /**
+ * Returns true if the configuration element is a regular file
+ *
+ * @param el
+ * @return
+ */
+ public boolean IsFile(IConfigurationElement el) {
+ return IsType(el, ConfigType.FILE.name());
+ }
+
+ /**
+ * Returns true if the configuration element is a MultiChoice or Multi
+ * Select option. You can call GetOption(el) to get a list of possible multi
+ * choice options.
+ *
+ * @param el
+ * @return
+ */
+ public boolean IsMultiChoice(IConfigurationElement el) {
+ return IsType(el, ConfigType.MULTICHOICE.name());
+ }
+
+ /**
+ * Returns true if the type is a password. Password fields should be masked
+ * out and are stored as Text.
+ *
+ * @param el
+ * @return
+ */
+ public boolean IsPassword(IConfigurationElement el) {
+ return IsType(el, ConfigType.PASSWORD.name());
+ }
+
+ /**
+ * Generic type check method that relies on the {@link ConfigType} for
+ * possible types.
+ *
+ * @param el
+ * @param type
+ * @return
+ */
+ public boolean IsType(IConfigurationElement el, String type) {
+ ConfigType t = ConfigType.toConfigType(type);
+ return (el != null && el instanceof Field && t == ((Field) el).getType());
+ }
+
+ /**
+ * For MultiChoice type fields, this is the list separator that should be
+ * used when storing multiple selections.
+ *
+ * @param f
+ * @return
+ */
+ public String GetListSeparator(Field f) {
+ return f.getListSeparator();
+ }
+
+ /**
+ * Returns true if the configuration field has possible selection options.
+ * For boolean types this will also return true, and you will have 2
+ * possible options for "true" and "false".
+ *
+ * @param f
+ * @return
+ */
+ public boolean HasOptions(Field f) {
+ List opts = GetOptions(f);
+ return opts != null && opts.size() > 0;
+ }
+
+ /**
+ * Returns the Options for a given field. May be null or empty. For booleans
+ * this will also return list of 2 items for "true" and "false"
+ *
+ * @param f
+ * @return
+ */
+ public List GetOptions(Field f) {
+ return f.getOptions();
+ }
+
+ /**
+ * For a given {@link NamedValue} option return the option's label.
+ *
+ * @param option
+ * @return
+ */
+ public String GetOptionLabel(NamedValue option) {
+ return option.getName();
+ }
+
+ /**
+ * For a given {@link NamedValue} option return the option's value.
+ *
+ * @param option
+ * @return
+ */
+ public String GetOptionValue(NamedValue option) {
+ return option.getValue();
+ }
+
+ /**
+ * A convenience method to lookup an option's Label for a given value. For
+ * example, you can find the label for a boolean field using
+ * GetOptionLable(field, "true", "OK").
+ *
+ * @param field
+ * Configuration {@link Field}
+ * @param value
+ * option value
+ * @param defLabel
+ * default label to return if the option's label is null, or the
+ * option does not exist.
+ * @return
+ */
+ public String GetOptionLabel(Field field, Object value, String defLabel) {
+ value = (value == null) ? null : String.valueOf(value);
+ List opts = field.getOptions();
+ if (opts != null) {
+ for (NamedValue nv : opts) {
+ if (value.equals(nv.getValue())) {
+ return nv.getName();
+ }
+ }
+ }
+ return defLabel;
+ }
+
+ /**
+ * Gets the {@link NamedValue} for the given value
+ *
+ * @param field
+ * @param value
+ * @return
+ */
+ public NamedValue GetOption(Field field, Object value) {
+ value = (value == null) ? null : String.valueOf(value);
+ List opts = field.getOptions();
+ if (opts != null) {
+ for (NamedValue nv : opts) {
+ if (value.equals(nv.getValue())) {
+ return nv;
+ }
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Returns the range of options for the given field, or null, if no options
+ * are provided.
+ *
+ * @param field
+ * @return
+ */
+ public String[] GetOptionRange(Field field) {
+ List opts = field.getOptions();
+ if (opts != null && opts.size() > 0) {
+ return new String[] { opts.get(0).getValue(), opts.get(opts.size() - 1).getValue() };
+ }
+ return null;
+ }
+
+ /**
+ * Returns true the the option's value is in the field's curValue list. ie,
+ * The option is selected because the field's current value is the same as
+ * the option. This should work for both Single Choice and Multi Choice
+ * options. For example, if the fields's current value is "12;24"
+ *
+ * @param field
+ * @param curValue
+ * @param option
+ * @return
+ */
+ public boolean IsSelected(NamedValue option, Field field, Object curValue) {
+ if (curValue == null || field == null || option == null)
+ return false;
+ curValue = String.valueOf(curValue);
+ String values[] = null;
+ if (IsMultiChoice(field)) {
+ values = ((String) curValue).split(field.getListSeparator());
+ } else {
+ values = new String[] { (String) curValue };
+ }
+ for (String v : values) {
+ if (v.equals(option.getValue())) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Returns a List of NamedValue object, that can be used as configuration
+ * option choices. The data can be a list, map, array, etc, and it will
+ * convert to the List of NamedValue objects.
+ *
+ * @param data
+ * @return
+ */
+ public List CreateOptionList(Object data) {
+ return ConfigUtils.getOptions(data);
+ }
+
+ /**
+ * Same as Toggle(Field) except uses the property Key.
+ *
+ * @param prop
+ */
+ public void Toggle(String prop) {
+ Toggle(GetField(prop));
+ }
+
+ /**
+ * For a boolean field it will toggle between true and false. For Choice
+ * options, it will toggle to next value in the choice. ie, if the choices
+ * are "1", "2", and "3", then calling Toggle when the value is "2" will set
+ * the value to "3", and calling Toggle when the value is "3" will set the
+ * value to "1".
+ *
+ * If field can't be toggled then nothing happens.
+ *
+ * @param f
+ * Field to toggle
+ */
+ public void Toggle(Field f) {
+ if (f.getType() == ConfigType.BOOL) {
+ SetProperty(f, !BooleanUtils.toBoolean(GetProperty(f)));
+ } else if (HasOptions(f)) {
+ String value = GetProperty(f);
+ List opts = f.getOptions();
+ int pos = -1;
+ for (int i = 0; i < opts.size(); i++) {
+ NamedValue nv = opts.get(i);
+ if (nv.getValue().equals(value)) {
+ pos = i + 1;
+ break;
+ }
+ }
+ pos = pos % (opts.size());
SetProperty(f, opts.get(pos).getValue());
- } else {
- // do nothing, we can't toggle
- }
- }
+ } else {
+ // do nothing, we can't toggle
+ }
+ }
}
diff --git a/src/main/java/phoenix/impl/DateTimeAPI.java b/src/main/java/phoenix/impl/DateTimeAPI.java
index f5802c4..267dd78 100644
--- a/src/main/java/phoenix/impl/DateTimeAPI.java
+++ b/src/main/java/phoenix/impl/DateTimeAPI.java
@@ -4,21 +4,25 @@
import sagex.phoenix.tools.annotation.API;
-@API(group="time")
+@API(group = "time")
public class DateTimeAPI {
/**
* Returns current time (same as Sage's Time() call)
+ *
* @return
*/
public long Now() {
return System.currentTimeMillis();
}
-
+
/**
- * Return the time for today, for the given hour and minute. Hour is 24hr time.
+ * Return the time for today, for the given hour and minute. Hour is 24hr
+ * time.
*
- * @param hr 24hr time
- * @param minute 0-59
+ * @param hr
+ * 24hr time
+ * @param minute
+ * 0-59
* @return date/time
*/
public long Time(int hr, int minute) {
@@ -30,10 +34,13 @@ public long Time(int hr, int minute) {
}
/**
- * Return the time for the given date, for the given hour and minute. Hour is 24hr time.
+ * Return the time for the given date, for the given hour and minute. Hour
+ * is 24hr time.
*
- * @param hr 24hr time
- * @param minute 0-59
+ * @param hr
+ * 24hr time
+ * @param minute
+ * 0-59
* @return date/time
*/
public long Time(long date, int hr, int minute) {
@@ -45,9 +52,9 @@ public long Time(long date, int hr, int minute) {
return now.getTimeInMillis();
}
-
/**
- * Returns the time for the given hr, min, and 'am' or 'pm' (ie, 2, 45, 'pm')
+ * Returns the time for the given hr, min, and 'am' or 'pm' (ie, 2, 45,
+ * 'pm')
*
* @param hr
* @param minute
@@ -55,12 +62,12 @@ public long Time(long date, int hr, int minute) {
* @return
*/
public long Time(int hr, int minute, String ampm) {
- if (hr<12 && "pm".equalsIgnoreCase(ampm)) {
- hr+=12;
+ if (hr < 12 && "pm".equalsIgnoreCase(ampm)) {
+ hr += 12;
}
- return Time(hr,minute);
+ return Time(hr, minute);
}
-
+
/**
* Adds number of hours to a given time (can be negative hours)
*
@@ -73,11 +80,12 @@ public long AddHours(long time, int hrs) {
cal.setTimeInMillis(time);
cal.add(Calendar.HOUR_OF_DAY, hrs);
return cal.getTimeInMillis();
- //return time + (hrs*60*60*1000);
+ // return time + (hrs*60*60*1000);
}
/**
* Adds number of mintues to a given time( can be negative minutes)
+ *
* @param time
* @param minutes
* @return
@@ -87,7 +95,7 @@ public long AddMinutes(long time, int minutes) {
cal.setTimeInMillis(time);
cal.add(Calendar.MINUTE, minutes);
return cal.getTimeInMillis();
- //return time + (minutes*60*1000);
+ // return time + (minutes*60*1000);
}
/**
@@ -103,24 +111,27 @@ public long AddDays(long time, int days) {
cal.add(Calendar.DAY_OF_YEAR, days);
return cal.getTimeInMillis();
}
-
+
/**
- * Returns the start and end times for for the given date a long array where the first element
- * is the start time and the second element is the end time.
- *
- * When calling StartAndEnd you can pass a number for the day offset. This will offset the date by
- * the number of days. ie, offset of 0 is today, offset of -1 is yesterday, offset of +1 is tomorrow.
+ * Returns the start and end times for for the given date a long array where
+ * the first element is the start time and the second element is the end
+ * time.
*
- * So to get the start and end times for tomorrow you can use StartAndEnd(Now(), 1) and it will return
- * the 2 date/time long values for the start of the day until the end of the day. (ie, 00:00 and 23:59)
+ * When calling StartAndEnd you can pass a number for the day offset. This
+ * will offset the date by the number of days. ie, offset of 0 is today,
+ * offset of -1 is yesterday, offset of +1 is tomorrow.
+ *
+ * So to get the start and end times for tomorrow you can use
+ * StartAndEnd(Now(), 1) and it will return the 2 date/time long values for
+ * the start of the day until the end of the day. (ie, 00:00 and 23:59)
*
* @return
*/
public long[] StartAndEnd(long date, int dayOffset) {
long d = AddDays(date, dayOffset);
- return new long[] {Time(d, 0,0), Time(d, 23,59)};
+ return new long[] { Time(d, 0, 0), Time(d, 23, 59) };
}
-
+
/**
* Convenience method for StartAndEnd(Now(), 0)
*
diff --git a/src/main/java/phoenix/impl/DeprecatedAPI.java b/src/main/java/phoenix/impl/DeprecatedAPI.java
index 698af0d..4d349a4 100644
--- a/src/main/java/phoenix/impl/DeprecatedAPI.java
+++ b/src/main/java/phoenix/impl/DeprecatedAPI.java
@@ -7,275 +7,276 @@
import sagex.phoenix.metadata.IMetadataSearchResult;
/**
- * This is where phoenix apis go when they are no longer used, supported, and ready to die.
+ * This is where phoenix apis go when they are no longer used, supported, and
+ * ready to die.
*
* @author seans
- *
+ *
*/
public class DeprecatedAPI {
- /**
- * Starts the Metadata/Fanart Scanner will an array of MediaFile objects.
- *
- * If a scan is in progress, then this scan is immediately aborted, and this
- * scan will not happen.
- *
- * The Scanner will start a separate thread for the scan and return
- * immediately
- *
- * TODO: Figure out a way to have the scanner notify on complete
- *
- * @param provider
- * provider to use for scanning, or null, to use the default
- * metadata provider
- * @param mediaFiles
- * Object Array of Sage MediaFile or Airing objects
- * @return ProgressTracker instance for the current scan, or null, if a scan
- * could not be started
- * @deprecated provider is no longer passed
- */
- public Object StartMetadataScan(Object provider, Object[] mediaFiles) {
- return null;
- }
+ /**
+ * Starts the Metadata/Fanart Scanner will an array of MediaFile objects.
+ *
+ * If a scan is in progress, then this scan is immediately aborted, and this
+ * scan will not happen.
+ *
+ * The Scanner will start a separate thread for the scan and return
+ * immediately
+ *
+ * TODO: Figure out a way to have the scanner notify on complete
+ *
+ * @param provider
+ * provider to use for scanning, or null, to use the default
+ * metadata provider
+ * @param mediaFiles
+ * Object Array of Sage MediaFile or Airing objects
+ * @return ProgressTracker instance for the current scan, or null, if a scan
+ * could not be started
+ * @deprecated provider is no longer passed
+ */
+ public Object StartMetadataScan(Object provider, Object[] mediaFiles) {
+ return null;
+ }
+
+ /**
+ * Returns true if a metadata scan is currently in progress.
+ *
+ * @return true if scan in progress
+ * @deprecated use method that accepts a tracker
+ */
+ public boolean IsMetadataScanRunning() {
+ return false;
+ }
- /**
- * Returns true if a metadata scan is currently in progress.
- *
- * @return true if scan in progress
- * @deprecated use method that accepts a tracker
- */
- public boolean IsMetadataScanRunning() {
- return false;
- }
+ /**
+ * Returns the percent complete in the scan. 0 mean not started, 1 means
+ * completed.
+ *
+ * @return float value representing the percent complete of the current scan
+ * @deprecated use method that accepts a tracker
+ */
+ public float GetMetadataScanComplete() {
+ return 0;
+ }
- /**
- * Returns the percent complete in the scan. 0 mean not started, 1 means
- * completed.
- *
- * @return float value representing the percent complete of the current scan
- * @deprecated use method that accepts a tracker
- */
- public float GetMetadataScanComplete() {
- return 0;
- }
+ /**
+ * Performa metadata search using a specific metadata provider. If the
+ * provider is null, then the default provider will be used.
+ *
+ * @param provider
+ * metadata provider or null for the default
+ * @param mediaFile
+ * mediafile or mediafile title
+ *
+ * @return metadata
+ * @deprecated provider is no longer used
+ */
+ public IMetadataSearchResult[] GetMetadataSearchResults(Object provider, Object mediaFile) {
+ return null;
+ }
- /**
- * Performa metadata search using a specific metadata provider. If the
- * provider is null, then the default provider will be used.
- *
- * @param provider
- * metadata provider or null for the default
- * @param mediaFile
- * mediafile or mediafile title
- *
- * @return metadata
- * @deprecated provider is no longer used
- */
- public IMetadataSearchResult[] GetMetadataSearchResults(Object provider, Object mediaFile) {
- return null;
- }
- /**
- * Get an array of metadata providers that are installed, but are not
- * currently in use.
- *
- * @return array of metadata providers not currently being used
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public IMetadataProviderInfo[] GetInActiveMetadataProviders() {
- return null;
- }
+ /**
+ * Get an array of metadata providers that are installed, but are not
+ * currently in use.
+ *
+ * @return array of metadata providers not currently being used
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public IMetadataProviderInfo[] GetInActiveMetadataProviders() {
+ return null;
+ }
- /**
- * Get an array of metadata providers that are currently being used to
- * perform metadata lookups/fanart downloading. The array is ordered in the
- * order in which they will be querried for results.
- *
- * @return Array of metadata providers that is being used for metadata
- * lookups
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public IMetadataProviderInfo[] GetActiveMetadataProviders() {
- return null;
- }
+ /**
+ * Get an array of metadata providers that are currently being used to
+ * perform metadata lookups/fanart downloading. The array is ordered in the
+ * order in which they will be querried for results.
+ *
+ * @return Array of metadata providers that is being used for metadata
+ * lookups
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public IMetadataProviderInfo[] GetActiveMetadataProviders() {
+ return null;
+ }
- /**
- * Get an array of all the available metadata providers installed in the
- * system.
- *
- * @return all metadata providers
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public IMetadataProviderInfo[] GetInstalledMetadataProviders() {
- return null;
- }
+ /**
+ * Get an array of all the available metadata providers installed in the
+ * system.
+ *
+ * @return all metadata providers
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public IMetadataProviderInfo[] GetInstalledMetadataProviders() {
+ return null;
+ }
- /**
- * Tests whether a given metadata provider is currently active and will
- * potentially be used for metadata lookups
- *
- * @param pi
- * metadata provider
- * @return true if the metadata provider is active
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public boolean IsActiveMetadataProvider(IMetadataProviderInfo pi) {
- return false;
- }
+ /**
+ * Tests whether a given metadata provider is currently active and will
+ * potentially be used for metadata lookups
+ *
+ * @param pi
+ * metadata provider
+ * @return true if the metadata provider is active
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public boolean IsActiveMetadataProvider(IMetadataProviderInfo pi) {
+ return false;
+ }
- /**
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- private boolean isActiveMetadataProvider(IMetadataProviderInfo provs[], IMetadataProviderInfo pi) {
- return false;
- }
+ /**
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ private boolean isActiveMetadataProvider(IMetadataProviderInfo provs[], IMetadataProviderInfo pi) {
+ return false;
+ }
- /**
- * within the array of active metadata providers, increase the priority of
- * this provide. ie, move it up in the list.
- *
- * @param pi
- * metadata provider
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public void IncreaseMetadataProviderPriority(IMetadataProviderInfo pi) {
- }
+ /**
+ * within the array of active metadata providers, increase the priority of
+ * this provide. ie, move it up in the list.
+ *
+ * @param pi
+ * metadata provider
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public void IncreaseMetadataProviderPriority(IMetadataProviderInfo pi) {
+ }
- /**
- * within the array of active metadata providers, decrease the priority of
- * this provider. ie, move it down in the list.
- *
- * @param pi
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public void DecreaseMetadataProviderPriority(IMetadataProviderInfo pi) {
- }
+ /**
+ * within the array of active metadata providers, decrease the priority of
+ * this provider. ie, move it down in the list.
+ *
+ * @param pi
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public void DecreaseMetadataProviderPriority(IMetadataProviderInfo pi) {
+ }
- /**
- * Add the given metadata provider to the list of active metadata providers.
- *
- * @param pi
- * metadata provider
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public void AddActiveMetadataProvider(IMetadataProviderInfo pi) {
- }
+ /**
+ * Add the given metadata provider to the list of active metadata providers.
+ *
+ * @param pi
+ * metadata provider
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public void AddActiveMetadataProvider(IMetadataProviderInfo pi) {
+ }
- /**
- * remove the metadata provider from the list of metadata providers. It is
- * still in the instaled list of providers.
- *
- * @param pi
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public void RemoveActiveMetadataProvider(IMetadataProviderInfo pi) {
- }
+ /**
+ * remove the metadata provider from the list of metadata providers. It is
+ * still in the instaled list of providers.
+ *
+ * @param pi
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public void RemoveActiveMetadataProvider(IMetadataProviderInfo pi) {
+ }
- /**
- * return the name of the provider id for the given provider.
- *
- * @param pi
- * privder object
- * @return provider id
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public String GetMetadataProviderId(IMetadataProviderInfo pi) {
- return pi.getId();
- }
+ /**
+ * return the name of the provider id for the given provider.
+ *
+ * @param pi
+ * privder object
+ * @return provider id
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public String GetMetadataProviderId(IMetadataProviderInfo pi) {
+ return pi.getId();
+ }
- /**
- * return the metadata provider name
- *
- * @param pi
- * provider object
- * @return provider name
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public String GetMetadataProviderName(IMetadataProviderInfo pi) {
- return pi.getName();
- }
+ /**
+ * return the metadata provider name
+ *
+ * @param pi
+ * provider object
+ * @return provider name
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public String GetMetadataProviderName(IMetadataProviderInfo pi) {
+ return pi.getName();
+ }
- /**
- * return the provider description
- *
- * @param pi
- * provider object
- * @return description
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public String GetMetadataProviderDescription(IMetadataProviderInfo pi) {
- return pi.getDescription();
- }
+ /**
+ * return the provider description
+ *
+ * @param pi
+ * provider object
+ * @return description
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public String GetMetadataProviderDescription(IMetadataProviderInfo pi) {
+ return pi.getDescription();
+ }
- /**
- * returns true if the current metadata provider support api is enabled. in
- * the event that no api is installed, a stub api is created which return
- * false. this is here to enable stv developers to check for the existence
- * of metadata search support, and if this is enabled, then calling search
- * methods on this api should also work.
- *
- * @return true if metadata searching support is enabled
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public boolean IsMetadataProviderSupportEnabled() {
- return true;
- }
+ /**
+ * returns true if the current metadata provider support api is enabled. in
+ * the event that no api is installed, a stub api is created which return
+ * false. this is here to enable stv developers to check for the existence
+ * of metadata search support, and if this is enabled, then calling search
+ * methods on this api should also work.
+ *
+ * @return true if metadata searching support is enabled
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public boolean IsMetadataProviderSupportEnabled() {
+ return true;
+ }
- /**
- * Get the known metadata keys for a given type. The type can be "S" for
- * Core Sage, "A" for all keys, or "E" for extended keys.
- *
- * @param type
- * "A" for all, "S" for core sage, "E" for extended
- * @return
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public String[] GetMetadataKeys(String type) {
- return null;
- }
+ /**
+ * Get the known metadata keys for a given type. The type can be "S" for
+ * Core Sage, "A" for all keys, or "E" for extended keys.
+ *
+ * @param type
+ * "A" for all, "S" for core sage, "E" for extended
+ * @return
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public String[] GetMetadataKeys(String type) {
+ return null;
+ }
- private Properties getLabelProperties() {
- Properties props = new Properties();
- return props;
- }
+ private Properties getLabelProperties() {
+ Properties props = new Properties();
+ return props;
+ }
- /**
- * Return a custom metadata label for a given metadata item.
- *
- * @param key
- * Metadata key
- * @return label
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public String GetMetadataLabel(String key) {
- return getLabelProperties().getProperty(key, key);
- }
+ /**
+ * Return a custom metadata label for a given metadata item.
+ *
+ * @param key
+ * Metadata key
+ * @return label
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public String GetMetadataLabel(String key) {
+ return getLabelProperties().getProperty(key, key);
+ }
- /**
- * return the metadata key description for a given key. The description can
- * be a simple description of the property, such as telling the user the
- * preferred data type, range, etc.
- *
- * @param key
- * metadata key
- * @return description
- * @deprecated configure using web ui, or using Configuration Metadata
- */
- public String GetMetadataDescription(String key) {
- return getLabelProperties().getProperty(key + "-Description", "");
- }
+ /**
+ * return the metadata key description for a given key. The description can
+ * be a simple description of the property, such as telling the user the
+ * preferred data type, range, etc.
+ *
+ * @param key
+ * metadata key
+ * @return description
+ * @deprecated configure using web ui, or using Configuration Metadata
+ */
+ public String GetMetadataDescription(String key) {
+ return getLabelProperties().getProperty(key + "-Description", "");
+ }
+ public long GetAiringStartTime(Object mediaFile) {
+ Object sage = phoenix.api.GetSageMediaFile(mediaFile);
+ return AiringAPI.GetAiringStartTime(sage);
+ }
- public long GetAiringStartTime(Object mediaFile) {
- Object sage = phoenix.api.GetSageMediaFile(mediaFile);
- return AiringAPI.GetAiringStartTime(sage);
- }
+ public long GetAiringEndTime(Object mediaFile) {
+ Object sage = phoenix.api.GetSageMediaFile(mediaFile);
+ return AiringAPI.GetAiringEndTime(sage);
+ }
- public long GetAiringEndTime(Object mediaFile) {
- Object sage = phoenix.api.GetSageMediaFile(mediaFile);
- return AiringAPI.GetAiringEndTime(sage);
- }
-
- public boolean IsAiringManualRecord(Object mediaFile) {
- Object sage = phoenix.api.GetSageMediaFile(mediaFile);
- return AiringAPI.IsManualRecord(sage);
- }
+ public boolean IsAiringManualRecord(Object mediaFile) {
+ Object sage = phoenix.api.GetSageMediaFile(mediaFile);
+ return AiringAPI.IsManualRecord(sage);
+ }
}
diff --git a/src/main/java/phoenix/impl/DynamicMenusAPI.java b/src/main/java/phoenix/impl/DynamicMenusAPI.java
index d58cb9c..6e82066 100644
--- a/src/main/java/phoenix/impl/DynamicMenusAPI.java
+++ b/src/main/java/phoenix/impl/DynamicMenusAPI.java
@@ -27,806 +27,899 @@
/**
* STV api calls related to Dynamic Menus.
*
- * NOTE: Many Dynamic Menu fields return a {@link DynamicVariable}. A {@link DynamicVariable} is like a regular
- * field but it can dynamically store a property reference, sage expression, or a static value.
+ * NOTE: Many Dynamic Menu fields return a {@link DynamicVariable}. A
+ * {@link DynamicVariable} is like a regular field but it can dynamically store
+ * a property reference, sage expression, or a static value.
*
- * For display purposes, any calls that return a {@link DynamicVariable} should display fine in the STV.
+ * For display purposes, any calls that return a {@link DynamicVariable} should
+ * display fine in the STV.
*
- * BUT, if you need to do logic on a DynamicValue (ie, boolean or int), then you should use the
- * GetComputedValue(DynamicValue) which will return the computed value as a type, ie, boolean, int, etc.
+ * BUT, if you need to do logic on a DynamicValue (ie, boolean or int), then you
+ * should use the GetComputedValue(DynamicValue) which will return the computed
+ * value as a type, ie, boolean, int, etc.
*
- * If you need to change the value of a {@link DynamicVariable} then you should use the SetStoredValue method
- * which enabled you to change the value of the variable. Using this method you can change the property,
- * expression or static value of a {@link DynamicVariable}.
+ * If you need to change the value of a {@link DynamicVariable} then you should
+ * use the SetStoredValue method which enabled you to change the value of the
+ * variable. Using this method you can change the property, expression or static
+ * value of a {@link DynamicVariable}.
*
* @author seans
- *
+ *
*/
-@API(group="menu")
+@API(group = "menu")
public class DynamicMenusAPI {
private Logger log = Logger.getLogger(this.getClass());
-
- /**
- * Get a Dynamic Menu for the Given Menu Name
- *
- * @param menu Menu name
- * @return Menu object
- */
- public Menu GetMenu(Object menu) {
- if (menu==null) return null;
- Menu m = null;
- if (menu instanceof Menu) {
- m = (Menu) menu;
- } else if (menu instanceof String) {
- m = Phoenix.getInstance().getMenuManager().getMenu((String)menu);
- }
-
- return m;
- }
-
- /**
- * Gets ALL the menu items for the given menu name or menu object.
- *
- * If you pass null, then it will assume you are requesting all menu items
- * from the root menu. ie, passing null returns a list of all ALL
- * loaded menu items.
- *
- * @param menu Menu object or Menu name
- * @return Array of visible Menu Items
- */
- public List GetMenuItems(Object menu) {
- if (menu==null) {
- return new ArrayList(GetMenus());
- }
-
- Menu m = GetMenu(menu);
- if (m==null) return null;
-
- return m.getItems();
- }
-
- /**
- * Returns ALL Loaded menus
- *
- * @return
- */
- public List